@factset/frontgate-js-sdk 7.1.4 → 7.1.6

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

@@ -0,0 +1,486 @@
+import type { Time } from '../types/Time';
+type Microseconds = Time;
+interface TransportLayerClientResponseHeaderPtlType {
+    id_job: number;
+    id_service: number;
+    expiry: {
+        microseconds: Microseconds;
+    };
+    flags: number;
+    cache_key: {
+        value: {
+            b64: string;
+        };
+    };
+    response_hash: {
+        value: string;
+    };
+    processing_time: number;
+}
+export interface TransportLayerClientRequestHeaderPtlType {
+    dataset: {
+        id_dataset: number;
+    };
+    id_job: number;
+    flags_r2: number;
+    resend_counter: number;
+    timeout: number;
+    authentication_identifiers: {
+        id_application: number;
+        id_user: number;
+    };
+    cache_key: {
+        value: number[];
+    };
+    previous_response_hash: {
+        value: number[];
+    };
+    tracing: {
+        value: {
+            value: number[];
+        };
+    };
+}
+export interface FoundationHighLevelResponsePtlMessage {
+    Message: 'HighLevelResponse' | 'Foundation::HighLevelResponse';
+    Version: number;
+    header: TransportLayerClientResponseHeaderPtlType;
+    body: {
+        value: string;
+    };
+    [prop: string]: unknown;
+}
+export interface TransportLayerClientJobSubscriptionUpdateHeader {
+    id_job: number;
+    processing_time: number;
+}
+export interface FoundationHighLevelUpdatePtlMessage {
+    Message: 'Foundation::HighLevelUpdate' | 'HighLevelUpdate';
+    Version: number;
+    header: TransportLayerClientJobSubscriptionUpdateHeader;
+    body: {
+        value: string;
+    };
+    [prop: string]: unknown;
+}
+export interface FoundationErrorResponsePtlMessage {
+    Message: 'Foundation::ErrorResponse';
+    Version: number;
+    header: Record<string, never>;
+    id_job: number;
+    processing_time: number;
+    reason: {
+        value: number;
+    };
+    details: string;
+    encrypted_details?: string;
+    payload_specific_data?: {
+        value: string;
+    };
+    [prop: string]: unknown;
+}
+export interface FoundationPingResponsePtlMessage {
+    Message: 'Foundation::PingResponse';
+    Version: number;
+    time_at_sender: {
+        microseconds: Microseconds;
+    };
+    time_from_request: {
+        microseconds: Microseconds;
+    };
+    [prop: string]: unknown;
+}
+export interface FoundationSubscriptionLossPtlMessage {
+    Message: 'Foundation::SubscriptionLoss';
+    Version: number;
+    reason: {
+        value: number;
+    };
+    header: {
+        id_job: number;
+        [prop: string]: unknown;
+    };
+    [prop: string]: unknown;
+}
+export interface FoundationOrderbookPriceResponsePtlMessage {
+    Message: 'Foundation::OrderbookPriceResponse';
+    Version: number;
+    header: TransportLayerClientResponseHeaderPtlType;
+    [prop: string]: unknown;
+}
+export interface FoundationOrderbookPriceRequestPtlMessage {
+    Message: 'Foundation::OrderbookPriceRequest';
+    Version: number;
+    header: TransportLayerClientRequestHeaderPtlType;
+    id_notation: number;
+    max_levels: number;
+    [prop: string]: unknown;
+}
+export interface FoundationOrderbookPriceEntryUpdatePtlMessage {
+    Message: 'Foundation::OrderbookPriceEntryUpdate';
+    Version: number;
+    id_notation: number;
+    header: {
+        id_service: number;
+        processing_time: number;
+        [prop: string]: unknown;
+    };
+    [prop: string]: unknown;
+}
+export interface FoundationAuthenticationResponsePtlMessage {
+    Message: 'Foundation::AuthenticationResponse';
+    Version: number;
+    result: {
+        responses: {
+            salt: {
+                value: {
+                    b64: string;
+                };
+            };
+            salted_hash_1: string;
+            salted_hash_2: string;
+            salted_hash_3: string;
+        }[];
+    };
+    challenge: {
+        challenge: {
+            b64: string;
+        };
+    };
+    id_user: number;
+    authentication: {
+        salt: {
+            value: {
+                b64: string;
+            };
+        };
+        encrypted_secrets: {
+            encrypted_secret: {
+                b64: string;
+            };
+        }[];
+    };
+    [prop: string]: unknown;
+}
+export interface FoundationAuthenticationTokenResponsePtlMessage {
+    Message: 'Foundation::AuthenticationTokenResponse';
+    Version: number;
+    header: TransportLayerClientResponseHeaderPtlType;
+    token: {
+        value: {
+            b64: string;
+        };
+    };
+    expiry: {
+        microseconds: Microseconds;
+    };
+    [prop: string]: unknown;
+}
+export interface FoundationHTTPProxyResponsePtlMessage {
+    Message: 'Foundation::HTTPProxyResponse';
+    Version: number;
+    header: TransportLayerClientResponseHeaderPtlType;
+    response: {
+        status_code: {
+            value: number;
+        };
+        status_reason: string;
+        headers: {
+            values: {
+                key: string;
+                value: string;
+            }[];
+        };
+        body: {
+            value: string;
+        };
+    };
+    info: {
+        api: string;
+        source_host: string;
+        source_port: number;
+    };
+    [prop: string]: unknown;
+}
+export interface AuthenticationByTokenResponsePtlMessage {
+    Message: 'AuthenticationByTokenResponse';
+    Version: number;
+    [prop: string]: unknown;
+}
+export interface FoundationConfigurationResponsePtlMessage {
+    Message: 'Foundation::ConfigurationResponse';
+    Version: number;
+    server_info: {
+        description: string;
+        software: string;
+        os: string;
+        uuid: {
+            id_1: string;
+            id_2: string;
+        };
+    };
+    payload_info: {
+        payload_type: {
+            value: number;
+        };
+        payload_content: string;
+        stripe_set: {
+            number_stripes: number;
+            bit_array: number[];
+        };
+        deployment_stage: {
+            value: number | string;
+        };
+        payload_details: {
+            payload: unknown[];
+        };
+        location: string;
+        operation_mode: {
+            value: number;
+        };
+    };
+    feature_flags_granted: {
+        value: string;
+    };
+    load: {
+        capacity: number;
+        idle: number;
+    };
+    maximum_idle_interval: number;
+    maximum_receivable_message_size: number;
+    time_at_server: {
+        microseconds: number;
+    };
+    [prop: string]: unknown;
+}
+export interface FoundationTransportLayerClientConfigurationResponsePtlMessage {
+    Message: 'Foundation::TransportLayerClientConfigurationResponse';
+    Version: number;
+    [prop: string]: unknown;
+}
+export interface FoundationDisconnectionMessagePtlMessage {
+    Message: 'Foundation::DisconnectionMessage';
+    Version: number;
+    reason: {
+        value: number;
+    };
+    details: string;
+    [prop: string]: unknown;
+}
+export interface PingRequestPtlMessage {
+    Message: 'PingRequest';
+    Version: number;
+    time_at_sender: {
+        microseconds: Microseconds;
+    };
+    [prop: string]: unknown;
+}
+export interface AuthenticationRequestPtlMessage {
+    Message: 'AuthenticationRequest';
+    Version: number;
+    challenge: {
+        challenge: number[];
+    };
+    id_peer: number;
+    id_application: number;
+    username: string;
+    authentication: {
+        salt: {
+            value: number[];
+        };
+        encrypted_secrets: {
+            encrypted_secret: number[];
+        }[];
+    };
+    [prop: string]: unknown;
+}
+export interface AuthenticationByTokenRequestPtlMessage {
+    Message: 'AuthenticationByTokenRequest';
+    Version: number;
+    token: {
+        value: {
+            b64: string;
+        };
+    };
+    software: string;
+    os: string;
+    feature_flags_wanted: {
+        value: number;
+    };
+    maximum_idle_interval: number;
+    maximum_receivable_message_size: number;
+    flags: number;
+    cache_authentication_salt: {
+        value: {
+            b64: string;
+        };
+    };
+    cache_authentication_encrypted_secret: {
+        encrypted_secret: {
+            b64: string;
+        };
+    };
+    [prop: string]: unknown;
+}
+export interface ConfigurationRequestPtlMessage {
+    Message: 'ConfigurationRequest';
+    Version: number;
+    result: {
+        responses: {
+            salt: {
+                value: number[];
+            };
+            salted_hash_1: string;
+            salted_hash_2: string;
+            salted_hash_3: string;
+        }[];
+    };
+    client_info: {
+        description: string;
+        software: string;
+        os: string;
+        uuid: {
+            id_1: number;
+            id_2: number;
+        };
+    };
+    payload_info: {
+        payload_type: {
+            value: number;
+        };
+        payload_content: string;
+        stripe_set: {
+            number_stripes: number;
+            bit_array: number[];
+        };
+        deployment_stage: {
+            value: number;
+        };
+        payload_details: {
+            payload: unknown[];
+        };
+        location: string;
+        operation_mode: {
+            value: number;
+        };
+    };
+    feature_flags_wanted: {
+        value: number;
+    };
+    maximum_idle_interval: number;
+    maximum_receivable_message_size: number;
+    time_at_client: {
+        microseconds: number;
+    };
+    [prop: string]: unknown;
+}
+export interface AuthenticationTokenRequestPtlMessage {
+    Message: 'AuthenticationTokenRequest';
+    Version: number;
+    header: TransportLayerClientRequestHeaderPtlType;
+    lifetime_seconds_r2: number;
+    flags: number;
+    [prop: string]: unknown;
+}
+export interface CancelSubscriptionRequestPtlMessage {
+    Message: 'CancelSubscriptionRequest';
+    Version: number;
+    header: TransportLayerClientRequestHeaderPtlType;
+    id_job_subscription: number;
+    [prop: string]: unknown;
+}
+export interface TransportLayerClientConfigurationRequestPtlMessage {
+    Message: 'TransportLayerClientConfigurationRequest';
+    Version: number;
+    flags: number;
+    [prop: string]: unknown;
+}
+export interface HighLevelRequestPtlMessage {
+    Message: 'HighLevelRequest';
+    Version: number;
+    header: TransportLayerClientRequestHeaderPtlType;
+    accept: string;
+    content_type: string;
+    body: {
+        value: string[];
+    };
+    path: string;
+    query: string;
+    method: {
+        value: number;
+    };
+    [prop: string]: unknown;
+}
+export interface HttpProxyRequestPtlMessage {
+    Message: 'HTTPProxyRequest';
+    Version: number;
+    header: TransportLayerClientRequestHeaderPtlType;
+    request: {
+        headers: {
+            values: {
+                key: string;
+                value: string;
+            };
+        };
+        protocol: {
+            value: number;
+        };
+        host: string;
+        port: string;
+        path: string;
+        query: string;
+        body: {
+            value: string[];
+        };
+        method: {
+            value: number;
+        };
+    };
+    [prop: string]: unknown;
+}
+export interface KeepAliveMessagePtlMessage {
+    Message: 'KeepAliveMessage';
+    Version: number;
+    [prop: string]: unknown;
+}
+export interface GenericHeaderPtlMessage {
+    Message: never;
+    header: object;
+    [prop: string]: unknown;
+}
+export interface GenericAuthenticatedPtlMessage {
+    Message: never;
+    header?: {
+        authentication_identifiers?: {
+            id_application?: number;
+            id_user?: number;
+        };
+    };
+    [prop: string]: unknown;
+}
+export interface GenericJobInRootPtlMessage {
+    Message: never;
+    id_job: number;
+    [prop: string]: unknown;
+}
+export interface GenericJobInHeaderPtlMessage {
+    Message: never;
+    header: {
+        id_job: number;
+    };
+    [prop: string]: unknown;
+}
+export interface GenericServiceAndNotationPtlMessage {
+    Message: never;
+    id_notation: number;
+    header: {
+        id_service: number;
+    };
+    [prop: string]: unknown;
+}
+export type PtlMessage = FoundationHighLevelResponsePtlMessage | FoundationHighLevelUpdatePtlMessage | FoundationErrorResponsePtlMessage | FoundationPingResponsePtlMessage | FoundationSubscriptionLossPtlMessage | FoundationOrderbookPriceResponsePtlMessage | FoundationOrderbookPriceRequestPtlMessage | FoundationOrderbookPriceEntryUpdatePtlMessage | FoundationAuthenticationResponsePtlMessage | FoundationAuthenticationTokenResponsePtlMessage | FoundationHTTPProxyResponsePtlMessage | AuthenticationByTokenResponsePtlMessage | AuthenticationTokenRequestPtlMessage | FoundationConfigurationResponsePtlMessage | FoundationTransportLayerClientConfigurationResponsePtlMessage | FoundationDisconnectionMessagePtlMessage | PingRequestPtlMessage | AuthenticationRequestPtlMessage | AuthenticationByTokenRequestPtlMessage | ConfigurationRequestPtlMessage | CancelSubscriptionRequestPtlMessage | TransportLayerClientConfigurationRequestPtlMessage | HttpProxyRequestPtlMessage | HighLevelRequestPtlMessage | KeepAliveMessagePtlMessage | GenericHeaderPtlMessage | GenericAuthenticatedPtlMessage | GenericJobInRootPtlMessage | GenericJobInHeaderPtlMessage | GenericServiceAndNotationPtlMessage;
+export declare const hasJobIdInRoot: (msg: PtlMessage) => msg is GenericJobInRootPtlMessage;
+export declare const hasJobIdInHeader: (msg: PtlMessage) => msg is GenericJobInHeaderPtlMessage;
+export declare const isServiceAndNotationBased: (msg: PtlMessage) => msg is GenericServiceAndNotationPtlMessage;
+export declare const isPtlMessageWithHeader: (msg: PtlMessage) => msg is GenericHeaderPtlMessage;
+export {};

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

@@ -1,3 +1,4 @@
 export * from './HighLevelRequestMethod';
 export * from './HighLevelRequestOptions';
 export * from './HTTPProxyRequestOptions';
+export * from './PtlMessage';

package/dist/lib/types/message/request/AbstractMdg2Request.d.ts

@@ -1,6 +1,6 @@
 import { TransportLayerClientRequestHeader } from './TransportLayerClientRequestHeader';
-import type { PtlMessage } from '../../common/interfaces/PtlMessage';
-export declare abstract class AbstractMdg2Request {
+import type { PtlMessage } from '../interfaces';
+export declare abstract class AbstractMdg2Request<Message = PtlMessage> {
     header: TransportLayerClientRequestHeader;
     protected coreMembers: {
         Version: number;
@@ -8,5 +8,5 @@ export declare abstract class AbstractMdg2Request {
     };
     protected members: Record<string, any>;
     protected constructor(message: string, version: number);
-    getPtlMessage(): PtlMessage;
+    getPtlMessage(): Message;
 }

package/dist/lib/types/message/request/AuthenticationByTokenRequest.d.ts

@@ -1,6 +1,9 @@
+import type { PtlMessage } from '../interfaces';
 export declare class AuthenticationByTokenRequest {
     private readonly token;
     private readonly maximumIdleInterval;
-    constructor(token: any, maximumIdleInterval: number);
-    toJson(): any;
+    constructor(token: {
+        b64: string;
+    }, maximumIdleInterval: number);
+    toJson(): PtlMessage;
 }

package/dist/lib/types/message/request/AuthenticationRequest.d.ts

@@ -1,17 +1,18 @@
-import type { PtlMessage } from '../../common/interfaces';
-export interface AuthenticationRequestOptions {
-    encryptedSecrets?: {
-        encrypted_secret: Buffer | number[];
+import type { AuthenticationRequestPtlMessage } from '../interfaces';
+interface AuthenticationRequestOptions {
+    encryptedSecrets: {
+        encrypted_secret: number[];
     }[];
-    idPeer?: number;
-    username?: string;
-    salt?: number[];
+    idPeer: number;
+    username: string;
+    salt: number[];
     challenge: number[];
     idApplication: number;
 }
 export declare class AuthenticationRequest {
     private static readonly DEFAULT_OPTIONS;
     private readonly options;
-    constructor(options: AuthenticationRequestOptions);
-    toJson(): PtlMessage;
+    constructor(options: Partial<AuthenticationRequestOptions>);
+    toJson(): AuthenticationRequestPtlMessage;
 }
+export {};

package/dist/lib/types/message/request/AuthenticationTokenRequest.d.ts

@@ -1,5 +1,6 @@
+import type { AuthenticationTokenRequestPtlMessage } from '../interfaces';
 import { AbstractMdg2Request } from './AbstractMdg2Request';
-export declare class AuthenticationTokenRequest extends AbstractMdg2Request {
+export declare class AuthenticationTokenRequest extends AbstractMdg2Request<AuthenticationTokenRequestPtlMessage> {
     static NAME: string;
     static VERSION: number;
     static LIFETIME_SECONDS_DEFAULT: number;

package/dist/lib/types/message/request/CancelSubscriptionRequest.d.ts

@@ -1,5 +1,6 @@
+import type { CancelSubscriptionRequestPtlMessage } from '../interfaces';
 import { AbstractMdg2Request } from './AbstractMdg2Request';
-export declare class CancelSubscriptionRequest extends AbstractMdg2Request {
+export declare class CancelSubscriptionRequest extends AbstractMdg2Request<CancelSubscriptionRequestPtlMessage> {
     static readonly NAME = "CancelSubscriptionRequest";
     static readonly VERSION = 6;
     constructor(jobId: number);

package/dist/lib/types/message/request/ConfigurationRequest.d.ts

@@ -1,14 +1,19 @@
 import type { DeploymentStage } from '../../connection';
+import type { ConfigurationRequestPtlMessage } from '../interfaces';
 export interface ConfigurationRequestOptions {
     shared_secret: Buffer;
     payload_content: string;
     deployment_stage: DeploymentStage;
     maximum_idle_interval: number;
 }
+type Challenge = string | {
+    b64: string;
+} | number[];
 export declare class ConfigurationRequest {
     private readonly challenge;
     private readonly options;
-    constructor(challenge: any, options: ConfigurationRequestOptions);
-    toJson(): any;
+    constructor(challenge: Challenge, options: ConfigurationRequestOptions);
+    toJson(): ConfigurationRequestPtlMessage;
     private static readChallenge;
 }
+export {};

package/dist/lib/types/message/request/HTTPProxyRequest.d.ts

@@ -1,7 +1,7 @@
 import { AbstractMdg2Request } from './AbstractMdg2Request';
-import type { HTTPProxyRequestOptions, HTTPMethod } from '../interfaces';
+import type { HTTPProxyRequestOptions, HTTPMethod, HttpProxyRequestPtlMessage } from '../interfaces';
 export type HTTPProxyRequestBody = string | Record<string, unknown> | unknown[];
-export declare class HTTPProxyRequest extends AbstractMdg2Request {
+export declare class HTTPProxyRequest extends AbstractMdg2Request<HttpProxyRequestPtlMessage> {
     static readonly NAME = "HTTPProxyRequest";
     static readonly VERSION = 2;
     static readonly PROTOCOL: {

package/dist/lib/types/message/request/HighLevelRequest.d.ts

@@ -1,6 +1,6 @@
-import type { HighLevelRequestMethod, HighLevelRequestOptions } from '../interfaces';
+import type { HighLevelRequestMethod, HighLevelRequestOptions, HighLevelRequestPtlMessage } from '../interfaces';
 import { AbstractMdg2Request } from './AbstractMdg2Request';
-export declare class HighLevelRequest extends AbstractMdg2Request {
+export declare class HighLevelRequest extends AbstractMdg2Request<HighLevelRequestPtlMessage> {
     static readonly NAME = "HighLevelRequest";
     static readonly VERSION = 3;
     static readonly METHOD: {

package/dist/lib/types/message/request/PingRequest.d.ts

@@ -1,16 +1,10 @@
-import type { Time } from '../types';
-import type { PtlMessage } from '../../common/interfaces';
-export interface PingRequestMessage extends PtlMessage {
-    time_at_sender: {
-        microseconds: Time;
-    };
-}
+import type { PingRequestPtlMessage } from '../interfaces';
 export declare class PingRequest {
     static readonly NAME = "PingRequest";
     static readonly VERSION = 3;
     private _timeAtSender;
     constructor();
-    getPtlMessage(): PingRequestMessage;
+    getPtlMessage(): PingRequestPtlMessage;
     resetTimeAtSender(): void;
     get timeAtSender(): number;
 }

package/dist/lib/types/message/request/TransportLayerClientRequestHeader.d.ts

@@ -1,31 +1,8 @@
 import type { Quality } from '../../common/types';
 import type { TransportLayerClientRequestHeaderFlag } from '../types';
 import { type SpanContext } from '@opentelemetry/api';
+import type { TransportLayerClientRequestHeaderPtlType } from '../interfaces';
 export declare const DEFAULT_TIMEOUT_IN_MS = 6000;
-export interface PtlTransportLayerClientRequestHeader {
-    dataset: {
-        id_dataset: number;
-    };
-    id_job: number;
-    flags_r2: number;
-    resend_counter: number;
-    timeout: number;
-    authentication_identifiers: {
-        id_application: number;
-        id_user: number;
-    };
-    cache_key: {
-        value: number[];
-    };
-    previous_response_hash: {
-        value: number[];
-    };
-    tracing: {
-        value: {
-            value: number[];
-        };
-    };
-}
 export declare class TransportLayerClientRequestHeader {
     static PRICE_QUALITY: {
         RLT: number;
@@ -35,7 +12,7 @@ export declare class TransportLayerClientRequestHeader {
     private static readonly FLAG_VALUE;
     private readonly headerMembers;
     private readonly flags;
-    getPtlMessage(): PtlTransportLayerClientRequestHeader;
+    getPtlMessage(): TransportLayerClientRequestHeaderPtlType;
     getQuality(): Quality;
     setQuality(quality: Quality): void;
     setIdApplication(idApplication: number, replaceValueIfSet?: boolean): void;
@@ -43,7 +20,7 @@ export declare class TransportLayerClientRequestHeader {
     setFlag(flag: TransportLayerClientRequestHeaderFlag, enable?: boolean): void;
     getFlagsValue(): number;
     isFlagValueSet(flagValue: TransportLayerClientRequestHeaderFlag): boolean;
-    setJobId(jobId: any): void;
+    setJobId(jobId: number): void;
     getJobId(): number;
     countResend(): void;
     getResendCounter(): number;

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

@@ -1,8 +1,8 @@
-import { Mdg2Response } from './Mdg2Response';
-export declare class AuthenticationTokenResponse extends Mdg2Response {
+import type { FoundationAuthenticationTokenResponsePtlMessage } from '../interfaces';
+export declare class AuthenticationTokenResponse {
     private readonly token;
     private readonly expiry;
-    constructor(raw: any);
+    constructor(raw: FoundationAuthenticationTokenResponsePtlMessage);
     getToken(): string;
     getExpiry(): number;
 }