@hokuto/jam-node/lib/esm/api/index.d.ts

JAM Node TS, guardians and utils

import { BaseRequest, StatsResponse } from "@hokuto/jam-core";
import * as Fetch from "./fetch.js";
import * as Params from "./params.js";
import * as Url from "./url.js";
export declare const JamNodeApi: {
    Map: {
        Search: Fetch.SearchViewBoxApi<import("@hokuto/jam-core").MapRequest, Partial<import("@hokuto/jam-core").MapSchema>, Partial<import("@hokuto/jam-core").MapFeatureSchema>>;
        Create: (args: import("@hokuto/jam-core").MapCreateRequest) => Promise<Partial<import("@hokuto/jam-core").MapSchema>>;
        Read: (args: import("@hokuto/jam-core").MapRequest) => Promise<Partial<import("@hokuto/jam-core").MapSchema>>;
        Update: (args: import("@hokuto/jam-core").MapUpdateRequest) => Promise<Partial<import("@hokuto/jam-core").MapSchema>>;
        Delete: (args: import("@hokuto/jam-core").MapRequest) => Promise<unknown>;
        Clone: (args: import("@hokuto/jam-core").MapRequest) => Promise<Partial<import("@hokuto/jam-core").MapSchema>>;
        Export: (args: import("@hokuto/jam-core").MapRequest) => Promise<Blob>;
        Import: (args: import("@hokuto/jam-core").ImportMapDataRequest) => Promise<{
            mapId: string;
        }>;
        Centroid: (args: import("@hokuto/jam-core").MapViewBoxRequest) => Promise<import("@hokuto/jam-core").MapCentroidSchema>;
        Image: (args: import("@hokuto/jam-core").MapViewBoxRequest, body?: Partial<import("@hokuto/jam-core").RequestOptions> | undefined) => Promise<Blob>;
        ImageUrl: (args: import("@hokuto/jam-core").MapViewBoxRequest) => string;
        Label: (args: import("@hokuto/jam-core").MapViewBoxRequest, body?: Partial<import("@hokuto/jam-core").RequestOptions> | undefined) => Promise<Blob>;
        LabelUrl: (args: import("@hokuto/jam-core").MapViewBoxRequest) => string;
        Pin: (args: import("@hokuto/jam-core").MapPinRequest) => Promise<import("@hokuto/jam-core").PinResponse>;
        ViewBox: (args: import("@hokuto/jam-core").MapViewBoxRequest) => Promise<import("@hokuto/jam-core").Boundaries>;
        Shape: (args: import("@hokuto/jam-core").MapViewBoxRequest) => Promise<import("@hokuto/jam-core").MapShapeResponse>;
        Svg: (args: import("@hokuto/jam-core").MapViewBoxRequest, body?: Partial<import("@hokuto/jam-core").RequestOptions> | undefined) => Promise<Blob>;
    };
    Atlas: {
        Search: Fetch.SearchViewBoxApi<import("@hokuto/jam-core").AtlasRequest, Partial<import("@hokuto/jam-core").AtlasDocument>, import("@hokuto/jam-core").AtlasMapResponse>;
        Create: (args: import("@hokuto/jam-core").AtlasCreateRequest) => Promise<Partial<import("@hokuto/jam-core").AtlasDocument>>;
        Read: (args: import("@hokuto/jam-core").AtlasReadRequest) => Promise<Partial<import("@hokuto/jam-core").AtlasDocument>>;
        Update: (args: import("@hokuto/jam-core").AtlasUpdateRequest) => Promise<Partial<import("@hokuto/jam-core").AtlasDocument>>;
        Delete: (args: import("@hokuto/jam-core").AtlasReadRequest) => Promise<unknown>;
        Clone: (args: import("@hokuto/jam-core").AtlasReadRequest) => Promise<Partial<import("@hokuto/jam-core").AtlasDocument>>;
        Export: (args: import("@hokuto/jam-core").AtlasReadRequest) => Promise<Blob>;
        Import: (args: import("@hokuto/jam-core").ImportAtlasDataRequest) => Promise<{
            atlasId: string;
        }>;
        Centroid: (args: import("@hokuto/jam-core").AtlasViewBoxRequest) => Promise<import("@hokuto/jam-core").AtlasCentroidSchema>;
        Image: (args: import("@hokuto/jam-core").AtlasViewBoxRequest, body?: Partial<import("@hokuto/jam-core").RequestOptions> | undefined) => Promise<Blob>;
        ImageUrl: (args: import("@hokuto/jam-core").AtlasViewBoxRequest) => string;
        Label: (args: import("@hokuto/jam-core").AtlasViewBoxRequest, body?: Partial<import("@hokuto/jam-core").RequestOptions> | undefined) => Promise<Blob>;
        LabelUrl: (args: import("@hokuto/jam-core").AtlasViewBoxRequest) => string;
        Pin: (args: import("@hokuto/jam-core").AtlasPinRequest) => Promise<import("@hokuto/jam-core").PinResponse>;
        ViewBox: (args: import("@hokuto/jam-core").AtlasViewBoxRequest) => Promise<import("@hokuto/jam-core").Boundaries>;
        Shape: (args: import("@hokuto/jam-core").AtlasViewBoxRequest) => Promise<import("@hokuto/jam-core").AtlasShapeResponse>;
        Svg: (args: import("@hokuto/jam-core").AtlasViewBoxRequest, body?: Partial<import("@hokuto/jam-core").RequestOptions> | undefined) => Promise<Blob>;
    };
    Style: {
        Search: Fetch.SearchFeatureApi<import("@hokuto/jam-core").StyleRequest, import("@hokuto/jam-core").StyleListSchema, import("@hokuto/jam-core").StyleFeatureDocument>;
        Create: (args: import("@hokuto/jam-core").StyleCreateRequest) => Promise<import("@hokuto/jam-core").StyleListSchema>;
        Read: (args: import("@hokuto/jam-core").StyleRequest) => Promise<import("@hokuto/jam-core").StyleListSchema>;
        Update: (args: import("@hokuto/jam-core").StyleUpdateRequest) => Promise<import("@hokuto/jam-core").StyleListSchema>;
        Delete: (args: import("@hokuto/jam-core").StyleRequest) => Promise<unknown>;
        Clone: (args: import("@hokuto/jam-core").StyleRequest) => Promise<import("@hokuto/jam-core").StyleListSchema>;
        Export: (args: import("@hokuto/jam-core").StyleRequest) => Promise<Blob>;
        Import: (args: import("@hokuto/jam-core").ImportStyleDataRequest) => Promise<{
            styleId: string;
        }>;
        Load: (args: import("@hokuto/jam-core").ImportStyleDataRequest) => Promise<{
            styleId: string;
        }>;
    };
    Template: {
        Search: Fetch.SearchBaseApi<import("@hokuto/jam-core").TemplateDocument>;
        Create: (args: import("@hokuto/jam-core").TemplateCreateRequest) => Promise<import("@hokuto/jam-core").TemplateDocument>;
        Read: (args: import("@hokuto/jam-core").TemplateRequest) => Promise<import("@hokuto/jam-core").TemplateDocument>;
        Update: (args: import("@hokuto/jam-core").TemplateUpdateRequest) => Promise<import("@hokuto/jam-core").TemplateDocument>;
        Delete: (args: import("@hokuto/jam-core").TemplateRequest) => Promise<unknown>;
        Clone: (args: import("@hokuto/jam-core").TemplateRequest) => Promise<import("@hokuto/jam-core").TemplateDocument>;
        Export: (args: import("@hokuto/jam-core").TemplateRequest) => Promise<Blob>;
        Import: (args: import("@hokuto/jam-core").ImportTemplateDataRequest) => Promise<{
            templateId: string;
        }>;
    };
    Stats: (args: BaseRequest) => Promise<StatsResponse>;
    Fetch: typeof Fetch;
    Params: typeof Params;
    Url: typeof Url;
};