fixparser 9.1.7-def37df3 → 9.1.7-edd9ee17

package/types/messagetemplates/MessageTemplates.d.ts

@@ -0,0 +1,32 @@
+import type { IFIXParser } from '../IFIXParser';
+import { Field } from '../fields/Field';
+import type { Message } from '../message/Message';
+/**
+ * Creates a Heartbeat message for the FIX session.
+ * Heartbeat messages are used to maintain the connection and indicate that the session is still active.
+ * Optionally includes a TestReqID if provided.
+ *
+ * @param {IFIXParser} parser - The FIX parser instance
+ * @param {Field} [testReqId] - Optional TestReqID field to include in the heartbeat
+ * @returns {Message} A FIX Heartbeat message
+ * @throws {Error} If the license is invalid
+ */
+export declare const heartBeat: (parser: IFIXParser, testReqId?: Field) => Message;
+/**
+ * Creates a Sequence Reset message for the FIX session.
+ * Used to reset the sequence numbers between two parties in a FIX session.
+ * Can be used to fill gaps in message sequences or to reset the sequence number.
+ *
+ * @param {IFIXParser} parser - The FIX parser instance
+ * @param {number} seqNo - The current sequence number
+ * @param {number} newSeqNo - The new sequence number to set
+ * @param {'Y' | 'N'} [gapFillFlag=GapFillFlag.GapFillMessage] - Flag indicating if this is a gap fill message
+ * @returns {Message} A FIX Sequence Reset message
+ * @throws {Error} If the license is invalid
+ */
+export declare const sequenceReset: (
+    parser: IFIXParser,
+    seqNo: number,
+    newSeqNo: number,
+    gapFillFlag?: 'Y' | 'N',
+) => Message;

package/types/messagetype/MessageType.d.ts

@@ -0,0 +1,138 @@
+import type { Field } from '../fields/Field';
+import type { Message } from '../message/Message';
+import type { ISpecDatatypes } from '../spec/SpecDatatypes';
+/**
+ * Reference types from the FIX specification.
+ *
+ * @public
+ */
+export type RefType = {
+    id: string;
+    name: string;
+    presence?: string;
+    added?: string;
+    addedEP?: string;
+    updated?: string;
+    updatedEP?: string;
+    annotation?: {
+        documentation: string;
+    };
+};
+/**
+ * Represents a code set in the FIX specification.
+ * Contains information about valid values for a field.
+ */
+export type CodeSet = {
+    name: string;
+    id: string;
+    value: string;
+    sort: string;
+    added?: string;
+    addedEP?: string;
+    updated?: string;
+    updatedEP?: string;
+    description: string;
+};
+/**
+ * Represents a data structure in the FIX specification.
+ * Contains information about fields, groups, and components that make up a message type.
+ */
+export type DataStructure = {
+    id: string;
+    added?: string;
+    category: string;
+    abbrName: string;
+    name: string;
+    type: string;
+    numInGroup?: {
+        id: string;
+        added: string;
+        description: string;
+    };
+    fieldRef: RefType[];
+    groupRef: RefType[];
+    componentRef: RefType[];
+    datatype: ISpecDatatypes;
+    codeSet: {
+        name: string;
+        id: string;
+        type: string;
+        added?: string;
+        addedEP?: string;
+        updated?: string;
+        updatedEP?: string;
+        description: string;
+        code: CodeSet[];
+    };
+    description: string;
+};
+/**
+ * Represents a structure in the FIX specification.
+ * Can be a component reference, field reference, or group reference.
+ */
+export type Structure = {
+    id: string;
+    added: string;
+    addedEP?: string;
+    updated?: string;
+    updatedEP?: string;
+    deprecated?: string;
+    presence?: string;
+    description?: string;
+    type: 'componentRef' | 'fieldRef' | 'groupRef';
+    data: DataStructure;
+};
+/**
+ * Represents a message type structure in the FIX specification.
+ * Contains information about a specific FIX message type, including its structure and metadata.
+ */
+export type MessageTypeStructure = {
+    id: string;
+    msgType: string;
+    abbrName: string;
+    name: string;
+    description?: string;
+    added?: string;
+    addedEP?: string;
+    updated?: string;
+    updatedEP?: string;
+    category: {
+        section: string;
+        added?: string;
+        addedEP?: string;
+        FIXMLFileName: string;
+        componentType: string;
+        name: string;
+        description?: string;
+    };
+    section: any;
+    structure: Structure[];
+};
+/**
+ * Class for managing FIX message types.
+ * Provides functionality to set message types and sequences for FIX messages.
+ */
+export declare class MessageType {
+    /** Cache map for storing message type structures */
+    cacheMap: Map<string, MessageTypeStructure>;
+    /**
+     * Creates a new MessageType instance and initializes the cache map
+     * with prebuilt message type structures.
+     */
+    constructor();
+    /**
+     * Sets the message type and related information for a FIX message.
+     * Updates the message's type, description, and structure based on the field value.
+     *
+     * @param {Message} message - The FIX message to update
+     * @param {Field} field - The field containing the message type value
+     */
+    setMessageType(message: Message, field: Field): void;
+    /**
+     * Sets the message sequence number for a FIX message.
+     *
+     * @param {Message} message - The FIX message to update
+     * @param {number} messageSequence - The sequence number to set
+     */
+    setMessageSequence(message: Message, messageSequence: number): void;
+}

package/types/session/ClientMessageProcessor.d.ts

@@ -0,0 +1,13 @@
+import type { FIXParser } from '../FIXParser';
+import type { FIXParser as FIXParserBrowser } from '../FIXParserBrowser';
+import type { Message } from '../message/Message';
+/**
+ * Processes incoming messages for a FIX client session.
+ * This function handles message sequence validation, logging, and routing to appropriate
+ * message handlers based on the message type. It also manages heartbeat timers and
+ * message sequence numbers.
+ *
+ * @param {FIXParser | FIXParserBrowser} parser - The FIX parser instance handling the session
+ * @param {Message} message - The message to process
+ */
+export declare const clientProcessMessage: (parser: FIXParser | FIXParserBrowser, message: Message) => void;

package/types/session/ServerMessageProcessor.d.ts

@@ -0,0 +1,13 @@
+import { type FIXServer } from '../FIXServer';
+import type { Message } from '../message/Message';
+/**
+ * Processes incoming messages for a FIX server session.
+ * This function handles message sequence validation, logging, and routing to appropriate
+ * message handlers based on the message type. It also manages heartbeat timers,
+ * message sequence numbers, and validates the license.
+ *
+ * @param {FIXServer} parser - The FIX server instance handling the session
+ * @param {Message} message - The message to process
+ * @throws {Error} If the license is invalid
+ */
+export declare const serverProcessMessage: (parser: FIXServer, message: Message) => void;

package/types/session/SessionFirstMessage.d.ts

@@ -0,0 +1,12 @@
+import type { IFIXParser } from '../IFIXParser';
+import type { Message } from '../message/Message';
+/**
+ * Handles the first message in a FIX session.
+ * This function validates that the first message is a Logon message.
+ * If not, it sends a Logout message and closes the connection.
+ *
+ * @param {IFIXParser} parser - The FIX parser instance handling the session
+ * @param {Message} message - The first message received in the session
+ * @returns {boolean} - Returns true if the first message is a Logon, false otherwise
+ */
+export declare const handleFirstMessage: (parser: IFIXParser, message: Message) => boolean;

package/types/session/SessionLogon.d.ts

@@ -0,0 +1,18 @@
+import type { IMessageStore } from 'fixparser-common';
+import type { IFIXParser } from '../IFIXParser';
+import type { Message } from '../message/Message';
+/**
+ * Handles the Logon message in a FIX session.
+ * This function processes the Logon message, validates the sender and target,
+ * and manages the session state accordingly.
+ *
+ * @param {IFIXParser} parser - The FIX parser instance handling the session
+ * @param {IMessageStore<Message>} messageStore - The message store for managing message sequences
+ * @param {Message} message - The Logon message to process
+ * @returns {boolean} - Returns true if the Logon was successful, false otherwise
+ */
+export declare const handleLogon: (
+    parser: IFIXParser,
+    messageStore: IMessageStore<Message>,
+    message: Message,
+) => boolean;

package/types/session/SessionLogout.d.ts

@@ -0,0 +1,3 @@
+import type { IFIXParser } from '../IFIXParser';
+import type { Message } from '../message/Message';
+export declare const handleLogout: (parser: IFIXParser, message: Message) => void;

package/types/session/SessionResendRequest.d.ts

@@ -0,0 +1,18 @@
+import type { IMessageStore } from 'fixparser-common';
+import type { IFIXParser } from '../IFIXParser';
+import type { Message } from '../message/Message';
+/**
+ * Handles the ResendRequest message in a FIX session.
+ * This function processes the ResendRequest message, retrieves the requested messages
+ * from the message store, and resends them with appropriate flags and timestamps.
+ * If messages are not found, it sends a SequenceReset message to fill the gap.
+ *
+ * @param {IFIXParser} parser - The FIX parser instance handling the session
+ * @param {IMessageStore<Message>} messageStore - The message store containing the messages to resend
+ * @param {Message} message - The ResendRequest message containing the sequence range to resend
+ */
+export declare const handleResendRequest: (
+    parser: IFIXParser,
+    messageStore: IMessageStore<Message>,
+    message: Message,
+) => void;

package/types/session/SessionSequence.d.ts

@@ -0,0 +1,12 @@
+import type { IFIXParser } from '../IFIXParser';
+import type { Message } from '../message/Message';
+/**
+ * Handles message sequence validation in a FIX session.
+ * This function checks if the received message's sequence number matches the expected sequence number.
+ * If there is a mismatch, it sends a ResendRequest message to request the missing messages.
+ *
+ * @param {IFIXParser} parser - The FIX parser instance handling the session
+ * @param {Message} message - The message to validate sequence number for
+ * @returns {boolean} - Returns true if the sequence number is valid, false otherwise
+ */
+export declare const handleSequence: (parser: IFIXParser, message: Message) => boolean;

package/types/session/SessionSequenceReset.d.ts

@@ -0,0 +1,11 @@
+import type { IFIXParser } from '../IFIXParser';
+import type { Message } from '../message/Message';
+/**
+ * Handles the SequenceReset message in a FIX session.
+ * This function processes the SequenceReset message and updates the message sequence number
+ * to the new value specified in the message.
+ *
+ * @param {IFIXParser} parser - The FIX parser instance handling the session
+ * @param {Message} message - The SequenceReset message containing the new sequence number
+ */
+export declare const handleSequenceReset: (parser: IFIXParser, message: Message) => void;

package/types/session/SessionTestRequest.d.ts

@@ -0,0 +1,11 @@
+import type { IFIXParser } from '../IFIXParser';
+import type { Message } from '../message/Message';
+/**
+ * Handles the TestRequest message in a FIX session.
+ * This function processes the TestRequest message and responds with a Heartbeat message.
+ * If the TestRequest contains a TestReqID, it is included in the Heartbeat response.
+ *
+ * @param {IFIXParser} parser - The FIX parser instance handling the session
+ * @param {Message} message - The TestRequest message to process
+ */
+export declare const handleTestRequest: (parser: IFIXParser, message: Message) => void;

package/types/spec/SpecCategories.d.ts

@@ -0,0 +1,11 @@
+export interface ISpecCategories {
+    name: string;
+    FIXMLFileName: string;
+    componentType: string;
+    section?: string;
+    added?: string;
+    addedEP?: string;
+    includeFile?: string;
+    description?: string;
+}
+export declare const CATEGORIES: ISpecCategories[];

package/types/spec/SpecComponents.d.ts

@@ -0,0 +1,30 @@
+import type { NumInGroup } from './SpecGroups';
+export type Ref = {
+    id: number;
+    added: string;
+    presence?: string;
+    addedEP?: string;
+    updated?: string;
+    updatedEP?: string;
+    deprecated?: string;
+    deprecatedEP?: string;
+    description?: string;
+};
+export interface ISpecComponents {
+    id: number;
+    name: string;
+    category: string;
+    abbrName: string;
+    description: string;
+    added: string;
+    fieldRef?: Ref[];
+    groupRef?: Ref[];
+    componentRef?: Ref[];
+    numInGroup?: NumInGroup;
+    addedEP?: string;
+    updated?: string;
+    updatedEP?: string;
+    deprecated?: string;
+    deprecatedEP?: string;
+}
+export declare const COMPONENTS: ISpecComponents[];

package/types/spec/SpecDatatypes.d.ts

@@ -0,0 +1,18 @@
+export interface ISpecDatatypes {
+    name: string;
+    added: string;
+    addedEP?: string;
+    updated?: string;
+    updatedEP?: string;
+    baseType?: string;
+    mappedDatatype?: {
+        builtin: string;
+        base: string;
+        standard: string;
+        minInclusive?: string;
+        pattern?: string;
+        description?: string;
+    };
+    description?: string;
+}
+export declare const DATATYPES: ISpecDatatypes[];

package/types/spec/SpecEnums.d.ts

@@ -0,0 +1,18 @@
+export interface ISpecEnums {
+    name: string;
+    id: string;
+    tag: number;
+    type: string;
+    codeSet: string;
+    value: string;
+    sort?: number;
+    group?: string;
+    added?: string;
+    addedEP?: string;
+    updated?: string;
+    updatedEP?: string;
+    deprecated?: string;
+    deprecatedEP?: string;
+    description?: string;
+}
+export declare const ENUMS: ISpecEnums[];

package/types/spec/SpecFields.d.ts

@@ -0,0 +1,19 @@
+export interface ISpecFields {
+    id: number;
+    type: string;
+    name: string;
+    description?: string;
+    abbrName?: string;
+    added?: string;
+    addedEP?: string;
+    updated?: string;
+    updatedEP?: string;
+    deprecated?: string;
+    deprecatedEP?: string;
+    baseCategory?: string;
+    baseCategoryAbbrName?: string;
+    unionDataType?: string;
+    lengthId?: string;
+    discriminatorId?: string;
+}
+export declare const FIELDS: ISpecFields[];

package/types/spec/SpecGroups.d.ts

@@ -0,0 +1,29 @@
+import type { Ref } from './SpecComponents';
+export type NumInGroup = {
+    id: number;
+    added?: string;
+    addedEP?: string;
+    updated?: string;
+    updatedEP?: string;
+    deprecated?: string;
+    deprecatedEP?: string;
+    description?: string;
+};
+export interface ISpecGroups {
+    id: number;
+    name: string;
+    category: string;
+    abbrName: string;
+    description: string;
+    added: string;
+    fieldRef?: Ref[];
+    groupRef?: Ref[];
+    componentRef?: Ref[];
+    numInGroup?: NumInGroup;
+    addedEP?: string;
+    updated?: string;
+    updatedEP?: string;
+    deprecated?: string;
+    deprecatedEP?: string;
+}
+export declare const GROUPS: ISpecGroups[];

package/types/spec/SpecSections.d.ts

@@ -0,0 +1,10 @@
+export interface ISpecSections {
+    SectionID: string;
+    Name: string;
+    DisplayOrder: number;
+    Volume: string;
+    NotReqXML: number;
+    FIXMLFileName: string;
+    Description: string;
+}
+export declare const SECTIONS: ISpecSections[];

package/types/util/FrameDecoder.d.ts

@@ -0,0 +1,7 @@
+import { Transform, type TransformCallback, type TransformOptions } from 'node:stream';
+export declare class FrameDecoder extends Transform {
+    data: string | undefined;
+    constructor(opts?: TransformOptions);
+    _transform(chunk: string, encoding: string, callback: TransformCallback): void;
+    destroy(error?: Error): this;
+}

package/types/util/timestamp.d.ts

@@ -0,0 +1,2 @@
+import type { Logger } from '../logger/Logger';
+export declare const timestamp: (dateObject: Date, logger: Logger) => string;

package/types/util/util.d.ts

@@ -0,0 +1,23 @@
+export type Version = {
+    version: string | undefined;
+    build: string | undefined;
+};
+declare global {
+    const __PACKAGE_VERSION__: string;
+    const __BUILD_TIME__: string;
+}
+export declare const version: Version;
+export type FIXValue = number | string | boolean | null | undefined;
+export type Parser = 'FIXServer' | 'FIXParser' | 'FIXParserBrowser';
+export declare const parseFixVersion: (version: FIXValue) => string;
+export declare const DEFAULT_FIX_VERSION: string;
+export declare const DEFAULT_HEARTBEAT_SECONDS: number;
+export declare const DEFAULT_TLS_TIMEOUT: number;
+export declare const DEFAULT_TLS_ENCODING: BufferEncoding;
+export declare const SOH: string;
+export declare const STRING_EQUALS: string;
+export declare const RE_ESCAPE: RegExp;
+export declare const RE_FIND: RegExp;
+export declare const READY_MS: number;
+export declare const pad: (value: number, size: number) => string;
+export { timestamp } from './timestamp';