@xyo-network/api 2.20.41 → 2.20.44

package/dist/esm/models/Api/Config.d.ts

@@ -1,24 +1,24 @@
-import { XyoApiReportable } from './Reportable';
-interface XyoApiConfig extends XyoApiReportable {
-    /** @description The domain where the api is located */
-    apiDomain: string;
-    /** @deprecated use the jwtToken instead*/
-    userid?: string;
-    /** @description The jwtToken of the currently logged in user */
-    jwtToken?: string;
-    /** @description The apiKey used for authentication */
-    apiKey?: string;
-    /** @description The location in the API tree where this API object is mounted */
-    root?: string;
-    /** @description The query string, if any, that is added to the end of every request */
-    query?: string;
-    /** @description Threshold for Content-Size to cause automatic gzip of request body [default = 1024] */
-    compressionThreshold?: number;
-    /** @description Throw on failures */
-    throwFailure?: boolean;
-    /** @description Throw on error */
-    throwError?: boolean;
-    /** @description Parent that should also report events from this api */
-    reportableParent?: XyoApiReportable;
-}
-export type { XyoApiConfig };
+import { XyoApiReportable } from './Reportable';
+interface XyoApiConfig extends XyoApiReportable {
+    /** @description The domain where the api is located */
+    apiDomain: string;
+    /** @deprecated use the jwtToken instead*/
+    userid?: string;
+    /** @description The jwtToken of the currently logged in user */
+    jwtToken?: string;
+    /** @description The apiKey used for authentication */
+    apiKey?: string;
+    /** @description The location in the API tree where this API object is mounted */
+    root?: string;
+    /** @description The query string, if any, that is added to the end of every request */
+    query?: string;
+    /** @description Threshold for Content-Size to cause automatic gzip of request body [default = 1024] */
+    compressionThreshold?: number;
+    /** @description Throw on failures */
+    throwFailure?: boolean;
+    /** @description Throw on error */
+    throwError?: boolean;
+    /** @description Parent that should also report events from this api */
+    reportableParent?: XyoApiReportable;
+}
+export type { XyoApiConfig };

package/dist/esm/models/Api/Config.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=Config.js.map

package/dist/esm/models/Api/Envelope.d.ts

@@ -1,14 +1,14 @@
-import { XyoApiError } from './Error';
-import { XyoApiWarning } from './Warning';
-export interface XyoApiEnvelopeBase {
-    warning?: XyoApiWarning[];
-}
-export interface XyoApiEnvelopeSuccess<T> extends XyoApiEnvelopeBase {
-    data: T;
-    error: never;
-}
-export interface XyoApiEnvelopeError extends XyoApiEnvelopeBase {
-    data: never;
-    error: XyoApiError[];
-}
-export declare type XyoApiEnvelope<T> = XyoApiEnvelopeSuccess<T> | XyoApiEnvelopeError;
+import { XyoApiError } from './Error';
+import { XyoApiWarning } from './Warning';
+export interface XyoApiEnvelopeBase {
+    warning?: XyoApiWarning[];
+}
+export interface XyoApiEnvelopeSuccess<T> extends XyoApiEnvelopeBase {
+    data: T;
+    error: never;
+}
+export interface XyoApiEnvelopeError extends XyoApiEnvelopeBase {
+    data: never;
+    error: XyoApiError[];
+}
+export declare type XyoApiEnvelope<T> = XyoApiEnvelopeSuccess<T> | XyoApiEnvelopeError;

package/dist/esm/models/Api/Envelope.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=Envelope.js.map

package/dist/esm/models/Api/Error.d.ts

@@ -1,4 +1,4 @@
-import { AxiosError } from 'axios';
-export interface XyoApiError<T = any, D = any> extends AxiosError<T, D> {
-    isXyoError: true;
-}
+import { AxiosError } from 'axios';
+export interface XyoApiError<T = any, D = any> extends AxiosError<T, D> {
+    isXyoError: true;
+}

package/dist/esm/models/Api/Error.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=Error.js.map

package/dist/esm/models/Api/Reportable.d.ts

@@ -1,7 +1,7 @@
-import { XyoApiError } from './Error';
-import { XyoApiResponse } from './Response';
-export interface XyoApiReportable {
-    onError?: (error: XyoApiError, depth: number) => void;
-    onFailure?: (response: XyoApiResponse, depth: number) => void;
-    onSuccess?: (response: XyoApiResponse, depth: number) => void;
-}
+import { XyoApiError } from './Error';
+import { XyoApiResponse } from './Response';
+export interface XyoApiReportable {
+    onError?: (error: XyoApiError, depth: number) => void;
+    onFailure?: (response: XyoApiResponse, depth: number) => void;
+    onSuccess?: (response: XyoApiResponse, depth: number) => void;
+}

package/dist/esm/models/Api/Reportable.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=Reportable.js.map

package/dist/esm/models/Api/Response.d.ts

@@ -1,7 +1,7 @@
-import { AxiosResponse } from 'axios';
-import { XyoApiEnvelope } from './Envelope';
-export declare type XyoApiResponse<T = unknown, D = unknown> = AxiosResponse<T, D>;
-export declare type XyoApiResponseBody<T> = T | undefined;
-export declare type XyoApiResponseTuple<T> = [T | undefined, XyoApiEnvelope<T | undefined>, XyoApiResponse<XyoApiEnvelope<T | undefined>>];
-export declare type XyoApiResponseTupleOrBody<T> = XyoApiResponseTuple<T> | XyoApiResponseBody<T>;
-export declare type XyoApiResponseType = 'body' | 'tuple';
+import { AxiosResponse } from 'axios';
+import { XyoApiEnvelope } from './Envelope';
+export declare type XyoApiResponse<T = unknown, D = unknown> = AxiosResponse<T, D>;
+export declare type XyoApiResponseBody<T> = T | undefined;
+export declare type XyoApiResponseTuple<T> = [T | undefined, XyoApiEnvelope<T | undefined>, XyoApiResponse<XyoApiEnvelope<T | undefined>>];
+export declare type XyoApiResponseTupleOrBody<T> = XyoApiResponseTuple<T> | XyoApiResponseBody<T>;
+export declare type XyoApiResponseType = 'body' | 'tuple';

package/dist/esm/models/Api/Response.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=Response.js.map

package/dist/esm/models/Api/Warning.d.ts

@@ -1 +1 @@
-export declare type XyoApiWarning = Error;
+export declare type XyoApiWarning = Error;

package/dist/esm/models/Api/Warning.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=Warning.js.map

package/dist/esm/models/Api/index.d.ts

@@ -1,6 +1,6 @@
-export * from './Config';
-export * from './Envelope';
-export * from './Error';
-export * from './Reportable';
-export * from './Response';
-export * from './Warning';
+export * from './Config';
+export * from './Envelope';
+export * from './Error';
+export * from './Reportable';
+export * from './Response';
+export * from './Warning';

package/dist/esm/models/Api/index.js

@@ -1,7 +1,7 @@
-export * from './Config';
-export * from './Envelope';
-export * from './Error';
-export * from './Reportable';
-export * from './Response';
-export * from './Warning';
+export * from './Config';
+export * from './Envelope';
+export * from './Error';
+export * from './Reportable';
+export * from './Response';
+export * from './Warning';
 //# sourceMappingURL=index.js.map

package/dist/esm/models/Archive.d.ts

@@ -1,24 +1,24 @@
-import { XyoArchivePath } from './ArchivePath';
-export declare type AccessLevel = 'public' | 'private' | 'none';
-export declare type AccessType = 'read' | 'remove' | 'create' | 'list';
-export declare type ExpirationWindow = 'create' | 'read';
-export interface XyoAccessControl {
-    access?: Record<AccessType, AccessLevel>;
-    expiration?: {
-        window?: ExpirationWindow;
-        delay?: number;
-    };
-}
-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 {
-    user?: string;
-    accessControl?: XyoAccessControl | boolean;
-}
+import { XyoArchivePath } from './ArchivePath';
+export declare type AccessLevel = 'public' | 'private' | 'none';
+export declare type AccessType = 'read' | 'remove' | 'create' | 'list';
+export declare type ExpirationWindow = 'create' | 'read';
+export interface XyoAccessControl {
+    access?: Record<AccessType, AccessLevel>;
+    expiration?: {
+        window?: ExpirationWindow;
+        delay?: number;
+    };
+}
+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 {
+    user?: string;
+    accessControl?: XyoAccessControl | boolean;
+}

package/dist/esm/models/Archive.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=Archive.js.map

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

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

package/dist/esm/models/ArchiveKey.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=ArchiveKey.js.map

package/dist/esm/models/ArchivePath.d.ts

@@ -1,3 +1,3 @@
-export interface XyoArchivePath {
-    archive: string;
-}
+export interface XyoArchivePath {
+    archive: string;
+}

package/dist/esm/models/ArchivePath.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=ArchivePath.js.map

package/dist/esm/models/index.d.ts

@@ -1,4 +1,4 @@
-export * from './Api';
-export * from './Archive';
-export * from './ArchiveKey';
-export * from './ArchivePath';
+export * from './Api';
+export * from './Archive';
+export * from './ArchiveKey';
+export * from './ArchivePath';

package/dist/esm/models/index.js

@@ -1,5 +1,5 @@
-export * from './Api';
-export * from './Archive';
-export * from './ArchiveKey';
-export * from './ArchivePath';
+export * from './Api';
+export * from './Archive';
+export * from './ArchiveKey';
+export * from './ArchivePath';
 //# sourceMappingURL=index.js.map

package/dist/esm/objToQuery.d.ts

@@ -1 +1 @@
-export declare const objToQuery: (obj: Record<string, string | number | undefined>) => string;
+export declare const objToQuery: (obj: Record<string, string | number | undefined>) => string;

package/dist/esm/objToQuery.js

@@ -1,9 +1,9 @@
-export const objToQuery = (obj) => {
-    return `?${Object.entries(obj)
-        .map(([key, value]) => {
-        return `${key}=${value}`;
-    })
-        .filter((value) => value !== undefined)
-        .join('&')}`;
-};
+export const objToQuery = (obj) => {
+    return `?${Object.entries(obj)
+        .map(([key, value]) => {
+        return `${key}=${value}`;
+    })
+        .filter((value) => value !== undefined)
+        .join('&')}`;
+};
 //# sourceMappingURL=objToQuery.js.map

package/package.json

@@ -10,7 +10,7 @@
   },
   "dependencies": {
     "@xylabs/sdk-js": "^2.5.7",
-    "@xyo-network/core": "^2.20.41",
+    "@xyo-network/core": "^2.20.44",
     "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.41",
+  "version": "2.20.44",
   "packageManager": "yarn@3.1.1"
 }

package/src/Archivist/Api.ts

@@ -1,4 +1,4 @@
-import { Huri, XyoAddressValue, XyoDataLike, XyoPayload } from '@xyo-network/core'
+import { Huri, XyoAddressValue, XyoBoundWitness, XyoDataLike, XyoPayload } from '@xyo-network/core'
 
 import { XyoApiBase } from '../Base'
 import { XyoApiResponseBody, XyoApiResponseTuple, XyoApiResponseTupleOrBody, XyoApiResponseType } from '../models'
@@ -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
@@ -70,6 +71,18 @@ export class XyoArchivistApi extends XyoApiBase {
     })
   }
 
+  /**
+   * Issues commands/queries as XyoBoundWitness wrapped XyoPayloads against a Node in the network
+   * @param archive Optional, the archive to issue the requests against
+   * @returns Confirmation for the request, as a BoundWitness, from the network Node
+   */
+  public node<TData extends XyoBoundWitness | XyoBoundWitness[] = XyoBoundWitness | XyoBoundWitness[]>(archive = 'temp') {
+    return new XyoArchivistNodeApi<TData>({
+      ...this.config,
+      root: `${this.root}${archive}/`,
+    })
+  }
+
   /** @deprecated use huri(huri) instead */
   public async get(huri: Huri | string): Promise<XyoApiResponseBody<XyoPayload>>
   /** @deprecated use huri(huri) instead */

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

@@ -0,0 +1,133 @@
+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', () => {
+    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().perform(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().perform(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().perform(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().perform(query)
+          expect(response).toBeDefined()
+          expect(Array.isArray(response)).toBeTruthy()
+          expect(validateAllResponseSchemas(response)).toBeTruthy()
+        })
+      })
+    })
+  })
+})

package/src/Archivist/Node/Api.ts

@@ -0,0 +1,61 @@
+import { assertEx, delay } from '@xylabs/sdk-js'
+import { XyoBoundWitness, XyoPayload } 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
+   * @param retryInterval
+   * @returns The results for the issued queries
+   */
+  public async perform(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]))
+  }
+}

package/src/Archivist/Node/index.ts

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