@xyo-network/api 2.20.44 → 2.20.47

package/dist/esm/User/Api.js

@@ -1,27 +1,27 @@
-import { XyoApiBase } from '../Base';
-import { XyoApiSimple } from '../Simple';
-export class XyoUserApi extends XyoApiBase {
-    get authenticated() {
-        return !!this.config.jwtToken;
-    }
-    get headers() {
-        const headers = {};
-        if (this.config.jwtToken) {
-            headers.Authorization = `Bearer ${this.config.jwtToken}`;
-        }
-        return headers;
-    }
-    get login() {
-        return new XyoApiSimple({
-            ...this.config,
-            root: `${this.root}login/`,
-        });
-    }
-    get profile() {
-        return new XyoApiSimple({
-            ...this.config,
-            root: `${this.root}profile/`,
-        });
-    }
-}
+import { XyoApiBase } from '../Base';
+import { XyoApiSimple } from '../Simple';
+export class XyoUserApi extends XyoApiBase {
+    get authenticated() {
+        return !!this.config.jwtToken;
+    }
+    get headers() {
+        const headers = {};
+        if (this.config.jwtToken) {
+            headers.Authorization = `Bearer ${this.config.jwtToken}`;
+        }
+        return headers;
+    }
+    get login() {
+        return new XyoApiSimple({
+            ...this.config,
+            root: `${this.root}login/`,
+        });
+    }
+    get profile() {
+        return new XyoApiSimple({
+            ...this.config,
+            root: `${this.root}profile/`,
+        });
+    }
+}
 //# sourceMappingURL=Api.js.map

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

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

package/dist/esm/User/index.js

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

package/dist/esm/WithArchive.d.ts

@@ -1,3 +1,3 @@
-export declare type WithArchive<XyoArchivistApiConfig> = XyoArchivistApiConfig & {
-    _archive?: string;
-};
+export declare type WithArchive<XyoArchivistApiConfig> = XyoArchivistApiConfig & {
+    _archive?: string;
+};

package/dist/esm/WithArchive.js

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

package/dist/esm/index.d.ts

@@ -1,7 +1,7 @@
-export * from './Archivist';
-export * from './Base';
-export * from './Diviner';
-export * from './models';
-export * from './Simple';
-export * from './User';
-export * from './WithArchive';
+export * from './Archivist';
+export * from './Base';
+export * from './Diviner';
+export * from './models';
+export * from './Simple';
+export * from './User';
+export * from './WithArchive';

package/dist/esm/index.js

@@ -1,8 +1,8 @@
-export * from './Archivist';
-export * from './Base';
-export * from './Diviner';
-export * from './models';
-export * from './Simple';
-export * from './User';
-export * from './WithArchive';
+export * from './Archivist';
+export * from './Base';
+export * from './Diviner';
+export * from './models';
+export * from './Simple';
+export * from './User';
+export * from './WithArchive';
 //# sourceMappingURL=index.js.map

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

@@ -9,26 +9,21 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xylabs/sdk-js": "^2.5.7",
-    "@xyo-network/core": "^2.20.44",
+    "@xylabs/sdk-js": "^2.5.9",
+    "@xyo-network/core": "^2.20.47",
     "axios": "^0.27.2",
     "pako": "^2.0.4",
     "uuid": "^8.3.2"
   },
   "description": "Primary SDK for using XYO Protocol 2.0",
   "devDependencies": {
-    "@babel/core": "^7.18.2",
-    "@babel/preset-env": "^7.18.2",
+    "@ethersproject/wallet": "^5.6.2",
     "@types/pako": "^2.0.0",
     "@types/uuid": "^8.3.4",
-    "@xylabs/eslint-config": "^2.3.22",
-    "@xylabs/ts-scripts": "^1.0.66",
-    "@xylabs/tsconfig": "^1.0.13",
+    "@xylabs/tsconfig": "^1.0.14",
     "dotenv": "^16.0.1",
-    "ethers": "^5.6.8",
-    "license-checker": "^25.0.1",
-    "tslib": "^2.4.0",
-    "typescript": "^4.7.3"
+    "ethers": "^5.6.9",
+    "tslib": "^2.4.0"
   },
   "browser": "dist/esm/index.js",
   "docs": "dist/docs.json",
@@ -61,12 +56,8 @@
     "type": "git",
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
   },
-  "scripts": {
-    "lint-pkg": "npmPkgJsonLint .",
-    "license": "yarn license-checker --exclude \"MIT, ISC, Apache-2.0, BSD, BSD-2-Clause, CC-BY-4.0, Unlicense, CC-BY-3.0, CC0-1.0\""
-  },
   "sideEffects": true,
   "types": "dist/esm/index.d.ts",
-  "version": "2.20.44",
+  "version": "2.20.47",
   "packageManager": "yarn@3.1.1"
 }

package/src/Archivist/ApiUtil.spec.ts

@@ -1,5 +1,5 @@
+import { Wallet } from '@ethersproject/wallet'
 import { XyoAccount } from '@xyo-network/core'
-import { Wallet } from 'ethers'
 import { v4 } from 'uuid'
 
 import { XyoArchivistApi } from './Api'
@@ -35,3 +35,9 @@ export const testSchemaPrefix = 'network.xyo.schema.test.'
 export const getSchemaName = (): string => {
   return `${testSchemaPrefix}${v4()}`
 }
+
+export const getTimestampMinutesFromNow = (minutes = 0) => {
+  const t = new Date()
+  t.setMinutes(t.getMinutes() + minutes)
+  return +t
+}

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

@@ -58,7 +58,7 @@ describe('XyoArchivistNodeApi', () => {
       beforeEach(async () => {
         id = await issueQuery()
       })
-      it('returns the query result', async () => {
+      it.skip('returns the query result', async () => {
         const api = new XyoArchivistApi(config)
         await delay(1000)
         const [_, payload, response] = await api.node().result(id).get('tuple')
@@ -84,13 +84,21 @@ describe('XyoArchivistNodeApi', () => {
       })
     })
   })
-  describe('perform', () => {
+  describe.skip('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.skip('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().perform(query)
+          const response = await api.node().performTransaction(query)
           expect(response).toBeDefined()
           expect(Array.isArray(response)).toBeTruthy()
           expect(validateAllResponseSchemas(response)).toBeTruthy()
@@ -100,7 +108,7 @@ describe('XyoArchivistNodeApi', () => {
         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)
+          const response = await api.node().performTransaction(query)
           expect(response).toBeDefined()
           expect(Array.isArray(response)).toBeTruthy()
           expect(validateAllResponseSchemas(response)).toBeTruthy()
@@ -112,7 +120,7 @@ describe('XyoArchivistNodeApi', () => {
         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)
+          const response = await api.node().performTransaction(query)
           expect(response).toBeDefined()
           expect(Array.isArray(response)).toBeTruthy()
           expect(validateAllResponseSchemas(response)).toBeTruthy()
@@ -122,7 +130,7 @@ describe('XyoArchivistNodeApi', () => {
         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)
+          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

@@ -1,5 +1,5 @@
 import { assertEx, delay } from '@xylabs/sdk-js'
-import { XyoBoundWitness, XyoPayload } from '@xyo-network/core'
+import { XyoBoundWitness, XyoBoundWitnessBuilder, XyoPayload, XyoPayloadBuilder } from '@xyo-network/core'
 
 import { XyoApiConfig, XyoApiResponseTuple } from '../../models'
 import { XyoApiSimple, XyoApiSimpleQuery } from '../../Simple'
@@ -36,11 +36,11 @@ export class XyoArchivistNodeApi<
   /**
    * Issue the supplied queries and wait (non-blocking) for the results
    * @param data The queries to issue
-   * @param timeout
-   * @param retryInterval
+   * @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 perform(data: D, timeout = 5000, retryInterval = 100) {
+  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')
@@ -58,4 +58,18 @@ export class XyoArchivistNodeApi<
     // 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/Payload/Api.spec.ts

@@ -3,7 +3,7 @@ import { config } from 'dotenv'
 
 import { XyoApiConfig, XyoApiError } from '../../models'
 import { XyoArchivistApi } from '../Api'
-import { getNewArchive } from '../ApiUtil.spec'
+import { getNewArchive, getTimestampMinutesFromNow } from '../ApiUtil.spec'
 
 config()
 
@@ -20,13 +20,15 @@ describe('XyoArchivistPayloadApi', () => {
     let archive = ''
     beforeEach(async () => {
       archive = await getNewArchive(api)
+      expect(archive).toBeTruthy()
     })
     describe('when order is ascending', () => {
       it('returns payloads greater than or equal to timestamp', async () => {
         try {
-          const timestamp = Date.now()
+          const timestamp = getTimestampMinutesFromNow(-1)
           const boundWitness = new XyoBoundWitnessBuilder().witness(XyoAccount.random()).build()
-          await api.archive(archive).block.post([boundWitness])
+          const blockResult = await api.archive(archive).block.post([boundWitness])
+          expect(blockResult?.length).toBe(1)
           const response = await api.archive(archive).block.find({ order: 'asc', timestamp })
           expect(response?.length).toBe(1)
           const actual = response?.[0]
@@ -43,8 +45,9 @@ describe('XyoArchivistPayloadApi', () => {
       it('returns payloads less than or equal to timestamp', async () => {
         try {
           const boundWitness = new XyoBoundWitnessBuilder().witness(XyoAccount.random()).build()
-          await api.archive(archive).block.post([boundWitness])
-          const timestamp = Date.now()
+          const blockResult = await api.archive(archive).block.post([boundWitness])
+          expect(blockResult?.length).toBe(1)
+          const timestamp = getTimestampMinutesFromNow(1)
           const response = await api.archive(archive).block.find({ order: 'desc', timestamp })
           expect(response?.length).toBe(1)
           const actual = response?.[0]