@evergis/api 4.1.6 → 4.1.8

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Kirill Protasov
+Copyright (c) 2025 Everpoint
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/README.md

@@ -1,21 +1,11 @@
 # @evergis/api
 
-```javascript
-import { Api } from '@evergis/api';
+Библиотека API.
 
-const api = new Api({
-  url: '/',
-});
-```
-
-## Possible Environment variables
+### Генерирование API
 
+```shell
+$ yarn generate
 ```
 
-NODE_ENV = "development" | "test" | "production"
-URL = "string"
-LOGIN = "string"
-PASSWORD = "string"
-WORKSPACE = "string"
-
-```
+***ВАЖНО!!!***: Никогда и ни при каких обстоятельствах нельзя вручную править файлы, размещенные в директории `lib/__generated__`!

package/dist/Api.d.ts

@@ -1,78 +1,78 @@
-import { Options as KyOptions } from "ky";
-import { HubConnection } from "@microsoft/signalr";
-import { HttpClient } from "./__generated__/HttpClient";
-import { DataSourceService } from "./__generated__/DataSourceService";
-import { QueryTokenAccessService } from "./__generated__/QueryTokenAccessService";
-import { SpatialReferencesService } from "./__generated__/SpatialReferencesService";
-import { CatalogService } from "./__generated__/CatalogService";
-import { EventEmitter } from "./EventEmitter";
-import { Account, AccountPreview, BulkOperations, Cameras, ClientSettings, Eql, Feedback, FileUpload, Filters, Geocode, Import, Layers, Names, Notification, PortalSettings, Projects, RemoteTaskManager, Resources, Security, Statistic, Tables, Tools, VectorTiles } from "./services";
-import { AuthenticateParams, LoginDc } from "./__generated__/data-contracts";
-export declare type ApiParams = {
-    url: string;
-    wsUrl?: string;
-    wsKeepAlive?: boolean;
-    snappingHubUrl?: string;
-    http?: HttpClient;
-    httpOptions?: KyOptions;
-    urlPath?: string;
-};
-export declare enum UrlPath {
-    Base = "/map",
-    Shared = "/shared",
-    Presentation = "/presentation",
-    Portal = "/portal"
-}
-export declare type SocAuthNetwork = "vk" | "facebook" | "google";
-export declare class Api extends EventEmitter {
-    protected readonly http: HttpClient;
-    private readonly wsUrl;
-    private readonly urlPath;
-    readonly url: string;
-    readonly layers: Layers;
-    readonly tables: Tables;
-    readonly projects: Projects;
-    readonly security: Security;
-    readonly notification: Notification;
-    readonly file: FileUpload;
-    readonly filters: Filters;
-    readonly import: Import;
-    readonly resources: Resources;
-    readonly geocode: Geocode;
-    readonly tools: Tools;
-    readonly account: Account;
-    readonly accountPreview: AccountPreview;
-    readonly clientSettings: ClientSettings;
-    readonly portalSettings: PortalSettings;
-    readonly names: Names;
-    readonly bulk: BulkOperations;
-    readonly statistic: Statistic;
-    readonly feedback: Feedback;
-    readonly snappingHub: HubConnection | null;
-    readonly vectorTiles: VectorTiles;
-    readonly spatialReference: SpatialReferencesService;
-    readonly eql: Eql;
-    readonly catalog: CatalogService;
-    readonly queryToken: QueryTokenAccessService;
-    readonly dataSource: DataSourceService;
-    readonly remoteTaskManager: RemoteTaskManager;
-    readonly cameras: Cameras;
-    constructor({ url, wsUrl, wsKeepAlive, snappingHubUrl, http, urlPath, httpOptions, }: ApiParams);
-    init({ authParams, authQueryParams, connectWs, fetchSettings, fetchUser, useJwt, }: {
-        authParams?: LoginDc;
-        authQueryParams?: AuthenticateParams;
-        connectWs?: boolean;
-        connectSignalR?: boolean;
-        fetchSettings?: boolean;
-        fetchUser?: boolean;
-        useJwt?: boolean;
-    }): Promise<void>;
-    isAcceptedNetwork(network: string): network is SocAuthNetwork;
-    socAuthLogin(network: SocAuthNetwork): Promise<void>;
-    connectWs(): Promise<void>;
-    connectSignalR(): Promise<void>;
-    logout(): Promise<void>;
-    private defineUrlPath;
-    get isShared(): boolean;
-    get isPresentation(): boolean;
-}
+import { Options as KyOptions } from 'ky';
+import { HubConnection } from '@microsoft/signalr';
+import { HttpClient } from './__generated__/HttpClient';
+import { DataSourceService } from './__generated__/DataSourceService';
+import { QueryTokenAccessService } from './__generated__/QueryTokenAccessService';
+import { SpatialReferencesService } from './__generated__/SpatialReferencesService';
+import { CatalogService } from './__generated__/CatalogService';
+import { EventEmitter } from './EventEmitter';
+import { Account, AccountPreview, BulkOperations, Cameras, ClientSettings, Eql, Feedback, FileUpload, Filters, Geocode, Import, Layers, Names, Notification, PortalSettings, Projects, RemoteTaskManager, Resources, Security, Statistic, Tables, Tools, VectorTiles } from './services';
+import { AuthenticateParams, LoginDc } from './__generated__/data-contracts';
+export type ApiParams = {
+    url: string;
+    wsUrl?: string;
+    wsKeepAlive?: boolean;
+    snappingHubUrl?: string;
+    http?: HttpClient;
+    httpOptions?: KyOptions;
+    urlPath?: string;
+};
+export declare enum UrlPath {
+    Base = "/map",
+    Shared = "/shared",
+    Presentation = "/presentation",
+    Portal = "/portal"
+}
+export type SocAuthNetwork = "vk" | "facebook" | "google";
+export declare class Api extends EventEmitter {
+    protected readonly http: HttpClient;
+    private readonly wsUrl;
+    private readonly urlPath;
+    readonly url: string;
+    readonly layers: Layers;
+    readonly tables: Tables;
+    readonly projects: Projects;
+    readonly security: Security;
+    readonly notification: Notification;
+    readonly file: FileUpload;
+    readonly filters: Filters;
+    readonly import: Import;
+    readonly resources: Resources;
+    readonly geocode: Geocode;
+    readonly tools: Tools;
+    readonly account: Account;
+    readonly accountPreview: AccountPreview;
+    readonly clientSettings: ClientSettings;
+    readonly portalSettings: PortalSettings;
+    readonly names: Names;
+    readonly bulk: BulkOperations;
+    readonly statistic: Statistic;
+    readonly feedback: Feedback;
+    readonly snappingHub: HubConnection | null;
+    readonly vectorTiles: VectorTiles;
+    readonly spatialReference: SpatialReferencesService;
+    readonly eql: Eql;
+    readonly catalog: CatalogService;
+    readonly queryToken: QueryTokenAccessService;
+    readonly dataSource: DataSourceService;
+    readonly remoteTaskManager: RemoteTaskManager;
+    readonly cameras: Cameras;
+    constructor({ url, wsUrl, wsKeepAlive, snappingHubUrl, http, urlPath, httpOptions, }: ApiParams);
+    init({ authParams, authQueryParams, connectWs, fetchSettings, fetchUser, useJwt, }: {
+        authParams?: LoginDc;
+        authQueryParams?: AuthenticateParams;
+        connectWs?: boolean;
+        connectSignalR?: boolean;
+        fetchSettings?: boolean;
+        fetchUser?: boolean;
+        useJwt?: boolean;
+    }): Promise<void>;
+    isAcceptedNetwork(network: string): network is SocAuthNetwork;
+    socAuthLogin(network: SocAuthNetwork): Promise<void>;
+    connectWs(): Promise<void>;
+    connectSignalR(): Promise<void>;
+    logout(): Promise<void>;
+    private defineUrlPath;
+    get isShared(): boolean;
+    get isPresentation(): boolean;
+}

package/dist/ApiEvent.d.ts

@@ -1,5 +1,5 @@
-export declare enum ApiEvent {
-    ConnectionLost = "ConnectionLost",
-    Unauthorized = "Unauthorized",
-    SessionClosed = "SessionClosed"
-}
+export declare enum ApiEvent {
+    ConnectionLost = "ConnectionLost",
+    Unauthorized = "Unauthorized",
+    SessionClosed = "SessionClosed"
+}

package/dist/EventEmitter.d.ts

@@ -1,11 +1,11 @@
-export declare type EventHandler = (event?: any) => void;
-export declare type WildCardEventHandler = (type: string, event?: any) => void;
-export declare class EventEmitter {
-    private handlers;
-    on(type: "*", handler: WildCardEventHandler): void;
-    on(type: string, handler: EventHandler): void;
-    off(type: "*", handler: WildCardEventHandler): void;
-    off(type: string, handler: EventHandler): void;
-    emit(type: string, event?: any): void;
-    once(type: string, handler: EventHandler): void;
-}
+export type EventHandler = (event?: any) => void;
+export type WildCardEventHandler = (type: string, event?: any) => void;
+export declare class EventEmitter {
+    private handlers;
+    on(type: "*", handler: WildCardEventHandler): void;
+    on(type: string, handler: EventHandler): void;
+    off(type: "*", handler: WildCardEventHandler): void;
+    off(type: string, handler: EventHandler): void;
+    emit(type: string, event?: any): void;
+    once(type: string, handler: EventHandler): void;
+}

package/dist/ExtendedHttpClient.d.ts

@@ -0,0 +1,5 @@
+import { Options as KyOptions } from 'ky';
+import { HttpClient } from './__generated__/HttpClient';
+export declare class ExtendedHttpClient extends HttpClient {
+    constructor(options?: KyOptions);
+}

package/dist/__generated__/AccountPreviewService.d.ts

@@ -1,81 +1,81 @@
-import { FileUploadResponse, UploadPreview1Payload, UploadPreviewPayload } from './data-contracts';
-import { Service } from './Service';
-/**
- * @title Spatial Processing Core API
- * @version 1.5.1.0
- * @baseUrl /sp
- */
-export declare class AccountPreviewService extends Service {
-    /**
-     * No description
-     *
-     * @tags AccountPreview
-     * @name GetPreview
-     * @operationId AccountPreviewController_GetPreview
-     * @summary Get current user preview image.
-     * @request GET:/account/user/preview
-     * @secure
-     * @response `200` OK
-     */
-    getPreview(): string;
-    /**
-     * No description
-     *
-     * @tags AccountPreview
-     * @name UploadPreview
-     * @operationId AccountPreviewController_UploadPreview
-     * @summary Set current user preview image.
-     * @request POST:/account/user/preview
-     * @secure
-     * @response `200` OK
-     */
-    uploadPreview(data: UploadPreviewPayload | FormData): Promise<FileUploadResponse>;
-    /**
-     * No description
-     *
-     * @tags AccountPreview
-     * @name DeletePreview
-     * @operationId AccountPreviewController_DeletePreview
-     * @summary Delete current user preview.
-     * @request DELETE:/account/user/preview
-     * @secure
-     * @response `200` OK
-     */
-    deletePreview(): Promise<void>;
-    /**
-     * No description
-     *
-     * @tags AccountPreview
-     * @name GetPreview1
-     * @operationId AccountPreviewController_GetPreview_1
-     * @summary Get user preview image.
-     * @request GET:/account/user/preview/{username}
-     * @secure
-     * @response `200` OK
-     */
-    getPreview1(username: string): string;
-    /**
-     * No description
-     *
-     * @tags AccountPreview
-     * @name UploadPreview1
-     * @operationId AccountPreviewController_UploadPreview_1
-     * @summary Set user preview image.
-     * @request POST:/account/user/preview/{username}
-     * @secure
-     * @response `200` OK
-     */
-    uploadPreview1(username: string, data: UploadPreview1Payload | FormData): Promise<FileUploadResponse>;
-    /**
-     * No description
-     *
-     * @tags AccountPreview
-     * @name DeletePreview1
-     * @operationId AccountPreviewController_DeletePreview_1
-     * @summary Delete user preview.
-     * @request DELETE:/account/user/preview/{username}
-     * @secure
-     * @response `200` OK
-     */
-    deletePreview1(username: string): Promise<void>;
-}
+import { Service } from './Service';
+import { FileUploadResponse, UploadPreview1Payload, UploadPreviewPayload } from './data-contracts';
+/**
+ * @title Spatial Processing Core API
+ * @version 1.5.1.0
+ * @baseUrl /sp
+ */
+export declare class AccountPreviewService extends Service {
+    /**
+     * No description
+     *
+     * @tags AccountPreview
+     * @name GetPreview
+     * @operationId AccountPreviewController_GetPreview
+     * @summary Get current user preview image.
+     * @request GET:/account/user/preview
+     * @secure
+     * @response `200` OK
+     */
+    getPreview(): string;
+    /**
+     * No description
+     *
+     * @tags AccountPreview
+     * @name UploadPreview
+     * @operationId AccountPreviewController_UploadPreview
+     * @summary Set current user preview image.
+     * @request POST:/account/user/preview
+     * @secure
+     * @response `200` OK
+     */
+    uploadPreview(data: UploadPreviewPayload | FormData): Promise<FileUploadResponse>;
+    /**
+     * No description
+     *
+     * @tags AccountPreview
+     * @name DeletePreview
+     * @operationId AccountPreviewController_DeletePreview
+     * @summary Delete current user preview.
+     * @request DELETE:/account/user/preview
+     * @secure
+     * @response `200` OK
+     */
+    deletePreview(): Promise<void>;
+    /**
+     * No description
+     *
+     * @tags AccountPreview
+     * @name GetPreview1
+     * @operationId AccountPreviewController_GetPreview_1
+     * @summary Get user preview image.
+     * @request GET:/account/user/preview/{username}
+     * @secure
+     * @response `200` OK
+     */
+    getPreview1(username: string): string;
+    /**
+     * No description
+     *
+     * @tags AccountPreview
+     * @name UploadPreview1
+     * @operationId AccountPreviewController_UploadPreview_1
+     * @summary Set user preview image.
+     * @request POST:/account/user/preview/{username}
+     * @secure
+     * @response `200` OK
+     */
+    uploadPreview1(username: string, data: UploadPreview1Payload | FormData): Promise<FileUploadResponse>;
+    /**
+     * No description
+     *
+     * @tags AccountPreview
+     * @name DeletePreview1
+     * @operationId AccountPreviewController_DeletePreview_1
+     * @summary Delete user preview.
+     * @request DELETE:/account/user/preview/{username}
+     * @secure
+     * @response `200` OK
+     */
+    deletePreview1(username: string): Promise<void>;
+}