@xyo-network/api 4.1.1 → 4.1.3

package/dist/neutral/index.d.ts

@@ -1,196 +1,7 @@
-import * as _xyo_network_payload_model from '@xyo-network/payload-model';
-import { Payload, PayloadFindFilter } from '@xyo-network/payload-model';
-import { ApiConfig, ApiReportable, ApiError, ApiResponse, ApiResponseBody, ApiResponseTuple, ApiEnvelope } from '@xyo-network/api-models';
-import { Huri } from '@xyo-network/huri';
-import { AxiosJson } from '@xylabs/axios';
-import { DivinerConfig } from '@xyo-network/diviner-model';
-
-declare class ApiBase<C extends ApiConfig = ApiConfig> implements ApiReportable {
-    readonly config: C;
-    protected axios: AxiosJson;
-    constructor(config: C);
-    get authenticated(): boolean;
-    protected get headers(): Record<string, string>;
-    protected get query(): string;
-    protected get root(): string;
-    private static resolveResponse;
-    private static shapeResponse;
-    onError(error: ApiError, depth?: number): void;
-    onFailure(response: ApiResponse, depth?: number): void;
-    onSuccess(response: ApiResponse, depth?: number): void;
-    protected deleteEndpoint<T = unknown>(endPoint?: string): Promise<ApiResponseBody<T>>;
-    protected deleteEndpoint<T = unknown>(endPoint?: string, responseType?: 'body'): Promise<ApiResponseBody<T>>;
-    protected deleteEndpoint<T = unknown>(endPoint?: string, responseType?: 'tuple'): Promise<ApiResponseTuple<T>>;
-    protected getEndpoint<T = unknown>(endPoint?: string): Promise<ApiResponseBody<T>>;
-    protected getEndpoint<T = unknown>(endPoint?: string, responseType?: 'body'): Promise<ApiResponseBody<T>>;
-    protected getEndpoint<T = unknown>(endPoint?: string, responseType?: 'tuple'): Promise<ApiResponseTuple<T>>;
-    protected handleMonitorResponseError<T>(error: ApiError, trapAxiosException: boolean): ApiResponse<ApiEnvelope<T>> | undefined;
-    protected monitorResponse<T>(closure: () => Promise<ApiResponse<ApiEnvelope<T>>>): Promise<ApiResponse<ApiEnvelope<T>> | undefined>;
-    protected postEndpoint<T = unknown, D = unknown>(endPoint?: string, data?: D): Promise<ApiResponseBody<T>>;
-    protected postEndpoint<T = unknown, D = unknown>(endPoint?: string, data?: D, responseType?: 'body'): Promise<ApiResponseBody<T>>;
-    protected postEndpoint<T = unknown, D = unknown>(endPoint?: string, data?: D, responseType?: 'tuple'): Promise<ApiResponseTuple<T>>;
-    protected putEndpoint<T = unknown, D = unknown>(endPoint?: string, data?: D): Promise<ApiResponseBody<T>>;
-    protected putEndpoint<T = unknown, D = unknown>(endPoint?: string, data?: D, responseType?: 'body'): Promise<ApiResponseBody<T>>;
-    protected putEndpoint<T = unknown, D = unknown>(endPoint?: string, data?: D, responseType?: 'tuple'): Promise<ApiResponseTuple<T>>;
-    private resolveRoot;
-}
-
-type ApiSimpleQuery = PayloadFindFilter;
-declare class ApiSimple<T = Payload, D = T, Q extends ApiSimpleQuery = ApiSimpleQuery, C extends ApiConfig = ApiConfig> extends ApiBase<C> {
-    delete(): Promise<ApiResponseBody<T>>;
-    delete(responseType?: 'body'): Promise<ApiResponseBody<T>>;
-    delete(responseType?: 'tuple'): Promise<ApiResponseTuple<T>>;
-    find(query?: Q): Promise<ApiResponseBody<T>>;
-    find(query?: Q, responseType?: 'body'): Promise<ApiResponseBody<T>>;
-    find(query?: Q, responseType?: 'tuple'): Promise<ApiResponseTuple<T>>;
-    get(): Promise<ApiResponseBody<T>>;
-    get(responseType?: 'body'): Promise<ApiResponseBody<T>>;
-    get(responseType?: 'tuple'): Promise<ApiResponseTuple<T>>;
-    post(data?: D): Promise<ApiResponseBody<T>>;
-    post(data?: D, responseType?: 'body'): Promise<ApiResponseBody<T>>;
-    post(data?: D, responseType?: 'tuple'): Promise<ApiResponseTuple<T>>;
-    put(data?: D): Promise<ApiResponseBody<T>>;
-    put(data?: D, responseType?: 'body'): Promise<ApiResponseBody<T>>;
-    put(data?: D, responseType?: 'tuple'): Promise<ApiResponseTuple<T>>;
-}
-
-declare class ArchivistApi<C extends ApiConfig = ApiConfig> extends ApiSimple<Payload[], C> {
-    huri(huri: Huri | string): ApiSimple<Payload, Payload, _xyo_network_payload_model.PayloadFindFilter, ApiConfig>;
-}
-
-interface GetLocationQueryResponse {
-    answerHash?: string;
-    queryHash: string;
-}
-
-interface LocationHeatmapPointProperties {
-    hash: string;
-    value: number;
-}
-
-declare const CurrentLocationWitnessSchema: "co.coinapp.currentlocationwitness";
-type CurrentLocationWitnessSchema = typeof CurrentLocationWitnessSchema;
-type CurrentLocationWitnessPayload = Payload<{
-    altitudeMeters: number;
-    directionDegrees: number;
-    latitude: number;
-    longitude: number;
-    quadkey: string;
-    schema: CurrentLocationWitnessSchema;
-    speedKph: number;
-}>;
-
-declare const LocationWitnessSchema: "network.xyo.location";
-type LocationWitnessSchema = typeof LocationWitnessSchema;
-interface Coordinates {
-    accuracy: number | null;
-    altitude: number | null;
-    altitudeAccuracy: number | null;
-    heading: number | null;
-    latitude: number;
-    longitude: number;
-    speed: number | null;
-}
-interface CurrentLocation {
-    coords: Coordinates;
-    timestamp: number;
-}
-type LocationWitnessPayload = Payload<{
-    currentLocation: CurrentLocation;
-    schema: LocationWitnessSchema;
-}>;
-
-declare const LocationHeatmapQuerySchema: "network.xyo.location.heatmap.query";
-type LocationHeatmapQuerySchema = typeof LocationHeatmapQuerySchema;
-declare const LocationHeatmapAnswerSchema: "network.xyo.location.heatmap.answer";
-type LocationHeatmapAnswerSchema = typeof LocationHeatmapAnswerSchema;
-type LocationHeatmapQuery = {
-    schema: LocationWitnessSchema;
-    startTime?: string;
-    stopTime?: string;
-};
-declare const isLocationHeatmapQuery: (query: Record<string, unknown>) => query is LocationHeatmapQuery;
-
-declare const LocationQuadkeyHeatmapQuerySchema: "network.xyo.location.heatmap.quadkey.query";
-type LocationQuadkeyHeatmapQuerySchema = typeof LocationQuadkeyHeatmapQuerySchema;
-declare const LocationQuadkeyHeatmapAnswerSchema: "network.xyo.location.heatmap.quadkey.answer";
-type LocationQuadkeyHeatmapAnswerSchema = typeof LocationQuadkeyHeatmapAnswerSchema;
-type LocationQuadkeyHeatmapQuery = {
-    schema: LocationWitnessSchema;
-    startTime?: string;
-    stopTime?: string;
-};
-declare const isLocationQuadkeyHeatmapQuery: (query: Record<string, unknown>) => query is LocationQuadkeyHeatmapQuery;
-
-interface LocationTimeRangePointProperties {
-    _archive: string;
-    _client: string;
-    _timestamp: number;
-    schema: LocationWitnessSchema;
-}
-
-declare const LocationTimeRangeQuerySchema: "network.xyo.location.range.query";
-type LocationTimeRangeQuerySchema = typeof LocationTimeRangeQuerySchema;
-declare const LocationTimeRangeAnswerSchema: "network.xyo.location.range.answer";
-type LocationTimeRangeAnswerSchema = typeof LocationTimeRangeAnswerSchema;
-type LocationTimeRangeQuery = {
-    schema: LocationWitnessSchema;
-    startTime?: string;
-    stopTime?: string;
-};
-declare const isLocationTimeRangeQuery: (query: Record<string, unknown>) => query is LocationTimeRangeQuery;
-
-type LocationQuerySchema = LocationQuadkeyHeatmapQuerySchema | LocationHeatmapQuerySchema | LocationTimeRangeQuerySchema;
-declare const isSupportedLocationQuerySchema: (schema: string) => schema is LocationQuerySchema;
-
-interface LocationQueryCreationRequest<TSchema extends LocationQuerySchema = LocationQuerySchema, TQuery extends Record<string, unknown> = Record<string, unknown>> {
-    query: TQuery;
-    resultArchive: string;
-    resultArchivist: ApiConfig;
-    schema: TSchema;
-    sourceArchive: string;
-    sourceArchivist: ApiConfig;
-}
-type LocationTimeRangeQueryCreationRequest = LocationQueryCreationRequest<LocationTimeRangeQuerySchema, LocationTimeRangeQuery>;
-type LocationHeatmapQueryCreationRequest = LocationQueryCreationRequest<LocationHeatmapQuerySchema, LocationHeatmapQuery>;
-type LocationQuadkeyHeatmapQueryCreationRequest = LocationQueryCreationRequest<LocationQuadkeyHeatmapQuerySchema, LocationQuadkeyHeatmapQuery>;
-type SupportedLocationQueryCreationRequest = LocationTimeRangeQueryCreationRequest | LocationHeatmapQueryCreationRequest | LocationQuadkeyHeatmapQueryCreationRequest;
-
-interface LocationQueryCreationResponse extends LocationQueryCreationRequest {
-    hash: string;
-}
-
-declare class LocationDivinerApi {
-    config: ApiConfig;
-    constructor(config: ApiConfig);
-    private get axiosRequestConfig();
-    getLocationQuery(hash: string): Promise<GetLocationQueryResponse>;
-    postLocationQuery(request: SupportedLocationQueryCreationRequest): Promise<LocationQueryCreationResponse>;
-}
-//# sourceMappingURL=LocationDivinerApi.d.ts.map
-
-declare const RemoteDivinerConfigSchema: "network.xyo.diviner.remote.config";
-type RemoteDivinerConfigSchema = typeof RemoteDivinerConfigSchema;
-type RemoteDivinerConfig = DivinerConfig & {
-    /** @deprecated use in params instead */
-    api?: ArchivistApi;
-    archive?: string;
-    schema: RemoteDivinerConfigSchema;
-};
-
-declare class RemoteDivinerError extends Error {
-    isRemoteDivinerError: boolean;
-    constructor(action: string, error: Error['cause'], message?: string);
-    static isRemoteDivinerError(error: unknown): RemoteDivinerError | undefined;
-}
-
-interface ArchivePath {
-    archive: string;
-}
-
-declare type WithArchive<ArchivistApiConfig> = ArchivistApiConfig & {
-    _archive?: string;
-};
-
-export { ApiBase, ApiSimple, ArchivistApi, CurrentLocationWitnessSchema, LocationDivinerApi, LocationHeatmapAnswerSchema, LocationHeatmapQuerySchema, LocationQuadkeyHeatmapAnswerSchema, LocationQuadkeyHeatmapQuerySchema, LocationTimeRangeAnswerSchema, LocationTimeRangeQuerySchema, LocationWitnessSchema, RemoteDivinerConfigSchema, RemoteDivinerError, isLocationHeatmapQuery, isLocationQuadkeyHeatmapQuery, isLocationTimeRangeQuery, isSupportedLocationQuerySchema };
-export type { ApiSimpleQuery, ArchivePath, Coordinates, CurrentLocation, CurrentLocationWitnessPayload, GetLocationQueryResponse, LocationHeatmapPointProperties, LocationHeatmapQuery, LocationHeatmapQueryCreationRequest, LocationQuadkeyHeatmapQuery, LocationQuadkeyHeatmapQueryCreationRequest, LocationQueryCreationRequest, LocationQueryCreationResponse, LocationQuerySchema, LocationTimeRangePointProperties, LocationTimeRangeQuery, LocationTimeRangeQueryCreationRequest, LocationWitnessPayload, RemoteDivinerConfig, SupportedLocationQueryCreationRequest, WithArchive };
+export * from './Api/index.ts';
+export * from './Base.ts';
+export * from './Diviner/index.ts';
+export * from './models/index.ts';
+export * from './Simple.ts';
+export * from './WithArchive.ts';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/api",
-  "version": "4.1.1",
+  "version": "4.1.3",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,24 +29,24 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/axios": "^4.13.15",
-    "@xylabs/typeof": "^4.13.15",
-    "@xyo-network/api-models": "^4.1.1",
-    "@xyo-network/diviner-model": "^4.1.1",
-    "@xyo-network/huri": "^4.1.1",
-    "@xyo-network/payload-model": "^4.1.1",
+    "@xylabs/axios": "^4.13.16",
+    "@xylabs/typeof": "^4.13.16",
+    "@xyo-network/api-models": "^4.1.3",
+    "@xyo-network/diviner-model": "^4.1.3",
+    "@xyo-network/huri": "^4.1.3",
+    "@xyo-network/payload-model": "^4.1.3",
     "axios": "^1.10.0"
   },
   "devDependencies": {
-    "@types/node": "^24.0.13",
+    "@types/node": "^24.0.14",
     "@types/uuid": "^10.0.0",
-    "@xylabs/object": "^4.13.15",
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.23",
-    "@xylabs/tsconfig": "^7.0.0-rc.23",
-    "@xylabs/vitest-extended": "^4.13.15",
-    "@xyo-network/boundwitness-model": "^4.1.1",
-    "@xyo-network/module-model": "^4.1.1",
-    "@xyo-network/query-payload-plugin": "^4.1.1",
+    "@xylabs/object": "^4.13.16",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
+    "@xylabs/tsconfig": "^7.0.0-rc.27",
+    "@xylabs/vitest-extended": "^4.13.16",
+    "@xyo-network/boundwitness-model": "^4.1.3",
+    "@xyo-network/module-model": "^4.1.3",
+    "@xyo-network/query-payload-plugin": "^4.1.3",
     "typescript": "^5.8.3",
     "uuid": "^11.1.0",
     "vitest": "^3.2.4"