@xyo-network/api 2.20.39 → 2.20.42

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.39",
+    "@xyo-network/core": "^2.20.42",
     "axios": "^0.27.2",
     "pako": "^2.0.4",
     "uuid": "^8.3.2"
@@ -67,6 +67,6 @@
   },
   "sideEffects": true,
   "types": "dist/esm/index.d.ts",
-  "version": "2.20.39",
+  "version": "2.20.42",
   "packageManager": "yarn@3.1.1"
 }

package/src/Archivist/Api.spec.ts

@@ -1,4 +1,4 @@
-import { XyoAccount, XyoBoundWitness, XyoBoundWitnessBuilder } from '@xyo-network/core'
+import { XyoAccount, XyoBoundWitness, XyoBoundWitnessBuilder, XyoPayload, XyoPayloadBuilder } from '@xyo-network/core'
 import { config } from 'dotenv'
 
 import { XyoApiConfig, XyoApiError } from '../models'
@@ -56,6 +56,31 @@ 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

@@ -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'
@@ -70,6 +70,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<TResponse extends XyoBoundWitness, TData extends XyoBoundWitness = TResponse>(archive?: string) {
+    return new XyoApiSimple<TResponse, TData>({
+      ...this.config,
+      root: archive ? `${this.root}${archive}/` : this.root,
+    })
+  }
+
   /** @deprecated use huri(huri) instead */
   public async get(huri: Huri | string): Promise<XyoApiResponseBody<XyoPayload>>
   /** @deprecated use huri(huri) instead */