@factset/frontgate-js-sdk 6.11.1 → 7.0.1

package/dist/lib/types/connection/FrontgateWSConnection.d.ts

@@ -1,23 +0,0 @@
-import type { AuthenticationInterface } from '../authentication';
-import type { PtlMessage } from '../common/interfaces';
-import type { FrontgateConnectionOptions } from './AbstractFrontgateConnection';
-import { AbstractFrontgateConnection } from './AbstractFrontgateConnection';
-import type { ConnectionInterface } from './ConnectionInterface';
-import type { JobPromise } from './JobPromise';
-export declare class FrontgateWSConnection extends AbstractFrontgateConnection implements ConnectionInterface {
-    private ws;
-    private resolveOnMessage;
-    constructor(auth: AuthenticationInterface, options?: Partial<FrontgateConnectionOptions>);
-    private openConnection;
-    private performAuthentication;
-    open(delayInMs?: any): Promise<void>;
-    close(reconnect?: boolean, logout?: boolean): Promise<void>;
-    send(msg: PtlMessage): JobPromise<PtlMessage>;
-    submit(msg: PtlMessage): Promise<PtlMessage>;
-    private sendMessage;
-    private openWebSocket;
-    private onWebSocketMessage;
-    private decodeMessage;
-    private static sanitizeOptions;
-    protected handleWsError(handleWsError: Error): void;
-}

package/dist/lib/types/connection/JobPromise.d.ts

@@ -1,3 +0,0 @@
-export declare class JobPromise<T> extends Promise<T> {
-    idJob?: number;
-}

package/dist/lib/types/connection/LatencyHandler.d.ts

@@ -1 +0,0 @@
-export type LatencyHandler = (timeOfRequest: number | undefined, latencyTotal: number | undefined, latencyAtPeer: number | undefined, message: string | undefined) => void;

package/dist/lib/types/connection/LatencyTracker.d.ts

@@ -1,13 +0,0 @@
-import type { AbstractFrontgateConnection, LatencyHandler } from './index';
-export declare class LatencyTracker {
-    private static readonly MAX_RESPONSE_LATENCY_MS;
-    private readonly cb;
-    private readonly conn;
-    private timeout;
-    private readonly request;
-    private isRequestPending;
-    constructor(cb: LatencyHandler, conn: AbstractFrontgateConnection);
-    start(interval: number): void;
-    stop(): void;
-    private handlePingResponse;
-}

package/dist/lib/types/connection/MessageProcessor.d.ts

@@ -1,2 +0,0 @@
-import type { PtlMessage } from '../common/interfaces/PtlMessage';
-export type MessageProcessor = (msg: PtlMessage) => boolean;

package/dist/lib/types/connection/util/Encoding.d.ts

@@ -1,9 +0,0 @@
-export type SupportedEncoding = 'jsjson-v2' | 'jsjsonc-v2';
-export declare class Encoding {
-    private static readonly SUPPORTED_ENCODINGS;
-    private static readonly PLAIN_JSON_ENCODINGS;
-    private static readonly COMPRESSED_ENCODINGS;
-    static isSupportedEncoding(encoding: SupportedEncoding): boolean;
-    static isPlainJson(encoding: SupportedEncoding): boolean;
-    static isCompressedJson(encoding: SupportedEncoding): boolean;
-}

package/dist/lib/types/core/RequestModule.d.ts

@@ -1,78 +0,0 @@
-import type { Subject } from 'rxjs';
-import type { PtlMessage, HighLevelRequestResult } from '../common/interfaces';
-import type { RequestQuality } from '../common/types';
-import type { LoggerInterface } from '../logger';
-import type { AbstractMdg2Request, HighLevelRequestMethod, HighLevelRequestOptions, HTTPMethod, HTTPProxyRequestOptions, PermissionDeniedResponse, HTTPProxyRequestBody } from '../message';
-import { ErrorResponse } from '../message';
-import { CookieTokenAuthenticationFactors } from '../authentication';
-import type { HTTPProxyRequestResult } from '../common/interfaces/result/HTTPProxyRequestResult';
-import type { Mdg2ClientOptions } from '../common/Mdg2ClientOptions';
-import type { ConnectionInterface } from '../connection';
-export interface Job {
-    msg: AbstractMdg2Request;
-    expirationTime: number;
-    request: {
-        json: any;
-        data?: any;
-    };
-    resolve: (arg?: any) => void;
-    reject: (arg?: any) => void;
-}
-export interface DebugMessage {
-    json: PtlMessage;
-    data?: Record<string, unknown>;
-}
-export interface DebugObject {
-    request: DebugMessage;
-    response: ErrorResponse | PermissionDeniedResponse;
-}
-export interface RequestItem {
-    msg: any;
-    resolve: any;
-    reject: any;
-    insertedAt?: number;
-}
-type RequestModuleOptions = Required<Pick<Mdg2ClientOptions, 'defaultTimeoutInMs' | 'defaultTimeoutTokenInMs' | 'maxTimeoutsBeforeReconnect' | 'flagPermissionDenied' | 'replaySubjectBufferSize'>>;
-export declare const DEFAULT_REQUEST_MODULE_OPTIONS: RequestModuleOptions;
-export declare class RequestModule {
-    private readonly getConnection;
-    private logger;
-    private readonly options;
-    private updateMessageHandler?;
-    private lossMessageHandler?;
-    requestSubject: Subject<RequestItem>;
-    private readonly jobs;
-    private readonly replaySubjectBufferSize;
-    private readonly rejectResponsesTimeout;
-    private timeoutCounter;
-    private subscription;
-    private readonly chunks;
-    constructor(getConnection: () => ConnectionInterface | undefined, logger: LoggerInterface, options?: RequestModuleOptions);
-    setLogger(logger: LoggerInterface): void;
-    reset(): void;
-    requestWithQuality(msg: AbstractMdg2Request, quality?: RequestQuality, timeOutInMs?: number): Promise<any>;
-    requestEndpoint(method: HighLevelRequestMethod, path: string, data?: Record<string, unknown>, options?: HighLevelRequestOptions, timeOutInMs?: number): Promise<HighLevelRequestResult>;
-    requestProxyEndpoint(method: HTTPMethod, path: string, body?: HTTPProxyRequestBody, options?: HTTPProxyRequestOptions, timeOutInMs?: number): Promise<HTTPProxyRequestResult>;
-    requestAuthenticationToken(lifetimeSeconds?: number, idUser?: number, idApplication?: number, timeOutInMs?: number): Promise<string>;
-    requestAuthenticationTokenExpiry(lifetimeSeconds?: number, idUser?: number, idApplication?: number, timeOutInMs?: number, otp?: boolean): Promise<{
-        token: string;
-        expiry: number;
-    }>;
-    requestAuthenticationTokenFactorsForCookieAuthentication(lifetimeSeconds?: number, idUser?: number, idApplication?: number, timeOutInMs?: number): Promise<CookieTokenAuthenticationFactors>;
-    onConnection(): void;
-    setUpdateMessageHandler(handler: (msg: any, jobId: number) => void): void;
-    setLossMessageHandler(handler: (msg: any, jobId: number) => void): void;
-    request(msg: AbstractMdg2Request, timeOutInMs?: number): Promise<any>;
-    reRequest(job: Job): void;
-    private requestBestQuality;
-    private prependCollectedChunks;
-    private collectChunk;
-    private handleMessage;
-    private rejectResponseHandler;
-    private getRejectResponseTimeout;
-    private sendRequest;
-    clearPendingRequests(): void;
-    private static supportedPermissionDeniedResponseMessages;
-    private static supportsChunkedResponse;
-}
-export {};

package/dist/lib/types/core/SubscriptionModule.d.ts

@@ -1,24 +0,0 @@
-import type { ObserveOptions, RequestResult } from '../common/interfaces';
-import type { HighLevelRequestMethod, JobObservable, HighLevelRequestOptions } from '../message';
-import type { RequestModule } from './RequestModule';
-import type { LoggerInterface } from '../logger';
-import type { Mdg2ClientOptions } from '../common/Mdg2ClientOptions';
-export type SubscriptionModuleOptions = Pick<Mdg2ClientOptions, 'shouldRestartSubscriptions'>;
-export declare const DEFAULT_SUBSCRIPTION_MODULE_OPTIONS: SubscriptionModuleOptions;
-export declare class SubscriptionModule {
-    private logger;
-    private readonly options;
-    private readonly subjectManager;
-    private readonly handler;
-    static defaultObserveOptions: ObserveOptions;
-    constructor(requestModule: RequestModule, logger: LoggerInterface, options?: SubscriptionModuleOptions);
-    setLogger(logger: LoggerInterface): void;
-    observeEndpoint(method: HighLevelRequestMethod, path: string, data: Record<string, unknown>, options?: ObserveOptions, requestOptions?: HighLevelRequestOptions): JobObservable<RequestResult>;
-    unobserveEndpoint(idJob: number): Promise<void>;
-    restartSubscriptions(): void;
-    clearPendingSubscriptions(): void;
-    clearPendingSubscription(idJob: number): void;
-    private lossHandler;
-    private updateHandler;
-    private findSubject;
-}

package/dist/lib/types/core/subscription/EndpointHandler.d.ts

@@ -1,37 +0,0 @@
-import type { Operation } from 'fast-json-patch';
-import { Subject } from 'rxjs';
-import type { ObserveOptions, RequestResult } from '../../common/interfaces';
-import type { HighLevelRequestMethod, HighLevelResponse, JobObservable, HighLevelRequestOptions } from '../../message';
-import type { SubjectManager } from './SubjectManager';
-import type { LoggerInterface } from '../../logger';
-import type { RequestModule } from '../RequestModule';
-export interface JobRequest {
-    path: string;
-    data: Record<string, unknown>;
-    method: HighLevelRequestMethod;
-    subject: Subject<JobObservable<RequestResult>>;
-    observable: JobObservable<RequestResult>;
-    options?: ObserveOptions;
-    requestOptions?: HighLevelRequestOptions;
-}
-export declare class EndpointHandler {
-    private readonly responses;
-    private readonly requestToJobMapper;
-    private readonly requestModule;
-    private logger;
-    private readonly subjectManager;
-    private readonly resultMapper;
-    private static readonly highLevelResponseFilter;
-    constructor(requestModule: RequestModule, subjectManager: SubjectManager<HighLevelResponse>, logger: LoggerInterface);
-    setLogger(logger: LoggerInterface): void;
-    observe(method: HighLevelRequestMethod, path: string, data: Record<string, unknown>, options?: ObserveOptions, requestOptions?: HighLevelRequestOptions): JobObservable<RequestResult>;
-    unobserve(idJob: number): Promise<void>;
-    findSubject(idJob: number): Subject<HighLevelResponse> | undefined;
-    registerEndpointResponse(idJob: number, response: HighLevelResponse): void;
-    registerEndpointRequest(idJob: number, subject: Subject<JobObservable<RequestResult>>, observable: JobObservable<RequestResult>, method: HighLevelRequestMethod, path: string, data: Record<string, unknown>, options?: ObserveOptions, requestOptions?: HighLevelRequestOptions): void;
-    applyEndpointJsonPatchUpdate(idJob: number, patch: Operation[]): HighLevelResponse;
-    restartSubscriptions(): void;
-    restartSubscription(jobId: number): void;
-    private resubscribe;
-    private validateOptions;
-}

package/dist/lib/types/core/subscription/SubjectManager.d.ts

@@ -1,21 +0,0 @@
-import type { LoggerInterface } from '../../logger';
-import type { Subject } from 'rxjs';
-import type { RequestQuality } from '../../common/types';
-import type { Mdg2Response } from '../../message';
-export interface SubjectContainer {
-    subject: Subject<Mdg2Response>;
-    serviceId: number;
-    quality: RequestQuality;
-    fieldInstances: number[];
-}
-export declare class SubjectManager<ResponseType = unknown> {
-    private readonly logger;
-    private readonly job;
-    constructor(logger: LoggerInterface);
-    hasJobSubject(idJob: number | string): boolean;
-    registerJobSubject(idJob: number | string, subject: Subject<ResponseType>): void;
-    findJobSubject(identifier: string | number): Subject<ResponseType> | undefined;
-    removeJobSubject(idJob: number | string): void;
-    getJobSubject(idJob: number | string): Subject<ResponseType> | undefined;
-    get jobs(): Map<string, Subject<ResponseType>>;
-}

package/dist/lib/types/message/MessageFactory.d.ts

@@ -1,29 +0,0 @@
-import * as responses from './response';
-export declare const FLAG_HAS_NEXT_CHUNK = 8;
-export interface RawMessage {
-    Message: string;
-    header?: {
-        id_job: number;
-        processingTime: number;
-        flags?: number;
-    };
-    body?: {
-        value: string;
-    };
-}
-export interface RawMdg2Response extends RawMessage {
-    header: {
-        id_job: number;
-        processingTime: number;
-        flags?: number;
-    };
-    body: {
-        value: string;
-    };
-}
-export declare class MessageFactory {
-    private static readonly msgNameSeparator;
-    private static readonly msgNameSeparatorLength;
-    static createMessage(msg: any): responses.Mdg2Response;
-    static hasNextChunk(msg: RawMessage): boolean;
-}

package/dist/lib/types/message/guards.d.ts

@@ -1,11 +0,0 @@
-import type { PermissionDeniedResponse } from '../index';
-import type { RawMessage } from './MessageFactory';
-import type { ErrorResponse, HighLevelResponse, Mdg2Response, RejectResponse } from './response';
-import type { HighLevelUpdate } from './update';
-export declare function isErrorResponse(response: Mdg2Response): response is ErrorResponse;
-export declare function isPermissionDeniedResponse(response: Mdg2Response): response is PermissionDeniedResponse;
-export declare function isHighLevelResponse(response: Mdg2Response): response is HighLevelResponse;
-export declare function isHighLevelResponseMessage(response: RawMessage): boolean;
-export declare function isRejectResponse(response: Mdg2Response): response is RejectResponse;
-export declare function isHighLevelUpdate(response: Mdg2Response): response is HighLevelUpdate;
-export declare function isSubscriptionLossMessage(response: Mdg2Response): boolean;

package/dist/lib/types/message/interfaces/JobObservable.d.ts

@@ -1,4 +0,0 @@
-import type { Observable } from 'rxjs';
-export interface JobObservable<T> extends Observable<T> {
-    idJob?: number;
-}

package/dist/lib/types/message/request/raw/RawRequestFactory.d.ts

@@ -1,4 +0,0 @@
-export declare class RawRequestFactory {
-    static createFromString(json: string): Record<string, any>;
-    static createFromObject(json: any): Record<string, any>;
-}

package/dist/lib/types/message/response/AuthenticationByTokenResponse.d.ts

@@ -1,20 +0,0 @@
-import type { PtlMessage } from '../../common/interfaces';
-export interface AuthenticationByTokenResponse extends PtlMessage {
-    server_info: {
-        description: string;
-        software: string;
-        os: string;
-        uuid: {
-            id_1: string;
-            id_2: string;
-        };
-    };
-    feature_flags_granted: {
-        value: string;
-    };
-    maximum_idle_interval: string;
-    maximum_receivable_message_size: number;
-    time_at_server: {
-        microseconds: string;
-    };
-}

package/dist/lib/types/message/response/CancelSubscriptionResponse.d.ts

@@ -1,3 +0,0 @@
-import { Mdg2Response } from './Mdg2Response';
-export declare class CancelSubscriptionResponse extends Mdg2Response {
-}

package/dist/lib/types/message/response/LoadNotificationMessage.d.ts

@@ -1,8 +0,0 @@
-import type { PtlMessage } from '../../common/interfaces';
-export interface LoadNotificationMessage extends PtlMessage {
-    load: {
-        capacity: number;
-        idle: number;
-    };
-    client_load_share: number;
-}

package/dist/lib/types/message/response/PermissionDeniedResponse.d.ts

@@ -1,4 +0,0 @@
-import { Mdg2Response } from './Mdg2Response';
-export declare class PermissionDeniedResponse extends Mdg2Response {
-    get reason(): string;
-}

package/dist/lib/types/message/response/RejectResponse.d.ts

@@ -1,5 +0,0 @@
-import { Mdg2Response } from './Mdg2Response';
-export declare class RejectResponse extends Mdg2Response {
-    get reason(): string;
-    get jobId(): number;
-}

package/dist/lib/types/message/update/SubscriptionLossMessage.d.ts

@@ -1,17 +0,0 @@
-import { Mdg2Response } from '../response';
-import type { PtlMessage } from '../../common/interfaces/PtlMessage';
-export interface ISubscriptionLossMessage extends PtlMessage {
-    header: {
-        id_job?: number;
-        id_service?: number;
-        processing_time?: number;
-    };
-    reason: {
-        value: number;
-    };
-}
-export declare class SubscriptionLossMessage extends Mdg2Response {
-    private readonly reason;
-    constructor(raw: ISubscriptionLossMessage);
-    get reasonValue(): any;
-}

package/dist/lib/types/util/TimeOutWrapper.d.ts

@@ -1,12 +0,0 @@
-export declare class TimeoutWrapper {
-    _id: number | null;
-    _delay: number | null;
-    static wrap<T>(promise: Promise<T>, delay: number, rejectReason?: string): Promise<T>;
-    constructor();
-    get id(): number | null;
-    get delay(): number | null;
-    set<T>(delay: number, rejectReason?: string): Promise<T>;
-    wrap<T>(promise: Promise<T>, delay: number, rejectReason?: string): Promise<T>;
-    clear(): void;
-    promiseFinally: <T>(promise: Promise<T>, fn: () => void) => Promise<T>;
-}