@dalmore/api-contracts 0.0.0-dev.0fb0042 → 0.0.0-dev.139a1fa

package/common/types/state-machine.types.d.ts

@@ -0,0 +1,591 @@
+import { z } from 'zod';
+import { TradeStatus, TransactionType, TransactionStatus } from './common.types';
+export declare enum StateMachineType {
+    AIC_VALIDATION = "AIC_VALIDATION",
+    FILE_REVIEW = "FILE_REVIEW",
+    FINALIZE_TRADE = "FINALIZE_TRADE"
+}
+export declare enum StateMachineEvents {
+    START = "START",
+    STEP_FORWARD = "STEP_FORWARD",
+    COMPLETE = "COMPLETE"
+}
+export declare enum StateMachineTags {
+    CAN_PROGRESS = "CAN_PROGRESS"
+}
+export declare const BaseStateMachineStates: {
+    readonly IDLE: "IDLE";
+    readonly COMPLETED: "COMPLETED";
+    readonly DONE: "DONE";
+};
+export type BaseStateMachineStatesType = typeof BaseStateMachineStates;
+declare const FinalizeTradePayloadZod: z.ZodEffects<z.ZodObject<{
+    txnChargedAmount: z.ZodNumber;
+    totalAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    tradeStatus: z.ZodNativeEnum<typeof TradeStatus>;
+    transactions: z.ZodDefault<z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+        type: z.ZodNativeEnum<typeof TransactionType>;
+        status: z.ZodNativeEnum<typeof TransactionStatus>;
+        amount: z.ZodNumber;
+        refundTransactions: z.ZodDefault<z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+            type: z.ZodNativeEnum<typeof TransactionType>;
+            status: z.ZodNativeEnum<typeof TransactionStatus>;
+            amount: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+        }, {
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+        }>, "many">>>>;
+    }, "strip", z.ZodTypeAny, {
+        type: TransactionType;
+        status: TransactionStatus;
+        amount: number;
+        refundTransactions: {
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+        }[] | null;
+    }, {
+        type: TransactionType;
+        status: TransactionStatus;
+        amount: number;
+        refundTransactions?: {
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+        }[] | null | undefined;
+    }>, "many">>>>;
+}, "strip", z.ZodTypeAny, {
+    tradeStatus: TradeStatus;
+    transactions: {
+        type: TransactionType;
+        status: TransactionStatus;
+        amount: number;
+        refundTransactions: {
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+        }[] | null;
+    }[] | null;
+    txnChargedAmount: number;
+    totalAmount?: number | null | undefined;
+}, {
+    tradeStatus: TradeStatus;
+    txnChargedAmount: number;
+    transactions?: {
+        type: TransactionType;
+        status: TransactionStatus;
+        amount: number;
+        refundTransactions?: {
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+        }[] | null | undefined;
+    }[] | null | undefined;
+    totalAmount?: number | null | undefined;
+}>, {
+    id: `trade_${string}`;
+    txnChargedAmount: number | null;
+    tradeStatus: TradeStatus;
+    totalAmount: number | null;
+    adjustments: never[];
+    transactions: {
+        id: `transaction_${string}`;
+        type: TransactionType;
+        status: TransactionStatus;
+        amount: number;
+        tradeId: `trade_${string}`;
+        refundTransactions: {
+            id: `refund_transaction_${string}`;
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+            transactionId: `transaction_${string}`;
+        }[];
+    }[];
+}, {
+    tradeStatus: TradeStatus;
+    txnChargedAmount: number;
+    transactions?: {
+        type: TransactionType;
+        status: TransactionStatus;
+        amount: number;
+        refundTransactions?: {
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+        }[] | null | undefined;
+    }[] | null | undefined;
+    totalAmount?: number | null | undefined;
+}>;
+export type FinalizeTradePayloadZod = z.infer<typeof FinalizeTradePayloadZod>;
+export declare const CreateStateMachineConfigurationZod: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodString;
+    type: z.ZodLiteral<StateMachineType.AIC_VALIDATION>;
+    payload: any;
+}, "strip", z.ZodTypeAny, {
+    type: StateMachineType.AIC_VALIDATION;
+    name: string;
+    description: string;
+    payload?: any;
+}, {
+    type: StateMachineType.AIC_VALIDATION;
+    name: string;
+    description: string;
+    payload?: any;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<StateMachineType.FILE_REVIEW>;
+    name: z.ZodString;
+    description: z.ZodString;
+    payload: any;
+}, "strip", z.ZodTypeAny, {
+    type: StateMachineType.FILE_REVIEW;
+    name: string;
+    description: string;
+    payload?: any;
+}, {
+    type: StateMachineType.FILE_REVIEW;
+    name: string;
+    description: string;
+    payload?: any;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<StateMachineType.FINALIZE_TRADE>;
+    name: z.ZodString;
+    description: z.ZodString;
+    payload: z.ZodEffects<z.ZodObject<{
+        txnChargedAmount: z.ZodNumber;
+        totalAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        tradeStatus: z.ZodNativeEnum<typeof TradeStatus>;
+        transactions: z.ZodDefault<z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+            type: z.ZodNativeEnum<typeof TransactionType>;
+            status: z.ZodNativeEnum<typeof TransactionStatus>;
+            amount: z.ZodNumber;
+            refundTransactions: z.ZodDefault<z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+                type: z.ZodNativeEnum<typeof TransactionType>;
+                status: z.ZodNativeEnum<typeof TransactionStatus>;
+                amount: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+            }, {
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+            }>, "many">>>>;
+        }, "strip", z.ZodTypeAny, {
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+            refundTransactions: {
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+            }[] | null;
+        }, {
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+            refundTransactions?: {
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+            }[] | null | undefined;
+        }>, "many">>>>;
+    }, "strip", z.ZodTypeAny, {
+        tradeStatus: TradeStatus;
+        transactions: {
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+            refundTransactions: {
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+            }[] | null;
+        }[] | null;
+        txnChargedAmount: number;
+        totalAmount?: number | null | undefined;
+    }, {
+        tradeStatus: TradeStatus;
+        txnChargedAmount: number;
+        transactions?: {
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+            refundTransactions?: {
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+            }[] | null | undefined;
+        }[] | null | undefined;
+        totalAmount?: number | null | undefined;
+    }>, {
+        id: `trade_${string}`;
+        txnChargedAmount: number | null;
+        tradeStatus: TradeStatus;
+        totalAmount: number | null;
+        adjustments: never[];
+        transactions: {
+            id: `transaction_${string}`;
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+            tradeId: `trade_${string}`;
+            refundTransactions: {
+                id: `refund_transaction_${string}`;
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+                transactionId: `transaction_${string}`;
+            }[];
+        }[];
+    }, {
+        tradeStatus: TradeStatus;
+        txnChargedAmount: number;
+        transactions?: {
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+            refundTransactions?: {
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+            }[] | null | undefined;
+        }[] | null | undefined;
+        totalAmount?: number | null | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: StateMachineType.FINALIZE_TRADE;
+    name: string;
+    description: string;
+    payload: {
+        id: `trade_${string}`;
+        txnChargedAmount: number | null;
+        tradeStatus: TradeStatus;
+        totalAmount: number | null;
+        adjustments: never[];
+        transactions: {
+            id: `transaction_${string}`;
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+            tradeId: `trade_${string}`;
+            refundTransactions: {
+                id: `refund_transaction_${string}`;
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+                transactionId: `transaction_${string}`;
+            }[];
+        }[];
+    };
+}, {
+    type: StateMachineType.FINALIZE_TRADE;
+    name: string;
+    description: string;
+    payload: {
+        tradeStatus: TradeStatus;
+        txnChargedAmount: number;
+        transactions?: {
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+            refundTransactions?: {
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+            }[] | null | undefined;
+        }[] | null | undefined;
+        totalAmount?: number | null | undefined;
+    };
+}>]>;
+export type CreateStateMachineConfigurationZod = z.infer<typeof CreateStateMachineConfigurationZod>;
+export declare const StateMachineConfigurationZod: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodString;
+    type: z.ZodNativeEnum<typeof StateMachineType>;
+    payload: z.ZodRecord<z.ZodString, z.ZodAny>;
+}, "strip", z.ZodTypeAny, {
+    type: StateMachineType;
+    id: string;
+    name: string;
+    description: string;
+    payload: Record<string, any>;
+}, {
+    type: StateMachineType;
+    id: string;
+    name: string;
+    description: string;
+    payload: Record<string, any>;
+}>;
+export type StateMachineConfigurationZod = z.infer<typeof StateMachineConfigurationZod>;
+export declare const StartStateMachineZod: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<StateMachineType.AIC_VALIDATION>;
+    payload: any;
+    debugMode: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    type: StateMachineType.AIC_VALIDATION;
+    debugMode: boolean;
+    payload?: any;
+}, {
+    type: StateMachineType.AIC_VALIDATION;
+    payload?: any;
+    debugMode?: boolean | undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<StateMachineType.FILE_REVIEW>;
+    payload: any;
+    debugMode: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    type: StateMachineType.FILE_REVIEW;
+    debugMode: boolean;
+    payload?: any;
+}, {
+    type: StateMachineType.FILE_REVIEW;
+    payload?: any;
+    debugMode?: boolean | undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<StateMachineType.FINALIZE_TRADE>;
+    payload: z.ZodEffects<z.ZodObject<{
+        txnChargedAmount: z.ZodNumber;
+        totalAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        tradeStatus: z.ZodNativeEnum<typeof TradeStatus>;
+        transactions: z.ZodDefault<z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+            type: z.ZodNativeEnum<typeof TransactionType>;
+            status: z.ZodNativeEnum<typeof TransactionStatus>;
+            amount: z.ZodNumber;
+            refundTransactions: z.ZodDefault<z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+                type: z.ZodNativeEnum<typeof TransactionType>;
+                status: z.ZodNativeEnum<typeof TransactionStatus>;
+                amount: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+            }, {
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+            }>, "many">>>>;
+        }, "strip", z.ZodTypeAny, {
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+            refundTransactions: {
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+            }[] | null;
+        }, {
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+            refundTransactions?: {
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+            }[] | null | undefined;
+        }>, "many">>>>;
+    }, "strip", z.ZodTypeAny, {
+        tradeStatus: TradeStatus;
+        transactions: {
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+            refundTransactions: {
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+            }[] | null;
+        }[] | null;
+        txnChargedAmount: number;
+        totalAmount?: number | null | undefined;
+    }, {
+        tradeStatus: TradeStatus;
+        txnChargedAmount: number;
+        transactions?: {
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+            refundTransactions?: {
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+            }[] | null | undefined;
+        }[] | null | undefined;
+        totalAmount?: number | null | undefined;
+    }>, {
+        id: `trade_${string}`;
+        txnChargedAmount: number | null;
+        tradeStatus: TradeStatus;
+        totalAmount: number | null;
+        adjustments: never[];
+        transactions: {
+            id: `transaction_${string}`;
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+            tradeId: `trade_${string}`;
+            refundTransactions: {
+                id: `refund_transaction_${string}`;
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+                transactionId: `transaction_${string}`;
+            }[];
+        }[];
+    }, {
+        tradeStatus: TradeStatus;
+        txnChargedAmount: number;
+        transactions?: {
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+            refundTransactions?: {
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+            }[] | null | undefined;
+        }[] | null | undefined;
+        totalAmount?: number | null | undefined;
+    }>;
+    debugMode: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    type: StateMachineType.FINALIZE_TRADE;
+    payload: {
+        id: `trade_${string}`;
+        txnChargedAmount: number | null;
+        tradeStatus: TradeStatus;
+        totalAmount: number | null;
+        adjustments: never[];
+        transactions: {
+            id: `transaction_${string}`;
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+            tradeId: `trade_${string}`;
+            refundTransactions: {
+                id: `refund_transaction_${string}`;
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+                transactionId: `transaction_${string}`;
+            }[];
+        }[];
+    };
+    debugMode: boolean;
+}, {
+    type: StateMachineType.FINALIZE_TRADE;
+    payload: {
+        tradeStatus: TradeStatus;
+        txnChargedAmount: number;
+        transactions?: {
+            type: TransactionType;
+            status: TransactionStatus;
+            amount: number;
+            refundTransactions?: {
+                type: TransactionType;
+                status: TransactionStatus;
+                amount: number;
+            }[] | null | undefined;
+        }[] | null | undefined;
+        totalAmount?: number | null | undefined;
+    };
+    debugMode?: boolean | undefined;
+}>]>;
+export type StartStateMachineZod = z.infer<typeof StartStateMachineZod>;
+export declare const DebugStateMachineZod: z.ZodObject<{
+    sessionId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    sessionId: string;
+}, {
+    sessionId: string;
+}>;
+export type DebugStateMachineZod = z.infer<typeof DebugStateMachineZod>;
+export declare const StateMachineTransitionZod: z.ZodObject<{
+    to: z.ZodString;
+    from: z.ZodString;
+    timestamp: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    from: string;
+    to: string;
+    timestamp: string;
+}, {
+    from: string;
+    to: string;
+    timestamp: string;
+}>;
+export type StateMachineTransitionZod = z.infer<typeof StateMachineTransitionZod>;
+export declare const StateMachineResponseZod: z.ZodObject<{
+    sessionId: z.ZodString;
+    currentState: z.ZodString;
+    error: z.ZodOptional<z.ZodString>;
+    transitionHistory: z.ZodArray<z.ZodObject<{
+        to: z.ZodString;
+        from: z.ZodString;
+        timestamp: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        from: string;
+        to: string;
+        timestamp: string;
+    }, {
+        from: string;
+        to: string;
+        timestamp: string;
+    }>, "many">;
+    isCompleted: z.ZodBoolean;
+    isDebugMode: z.ZodBoolean;
+    canTransition: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    isCompleted: boolean;
+    sessionId: string;
+    currentState: string;
+    transitionHistory: {
+        from: string;
+        to: string;
+        timestamp: string;
+    }[];
+    isDebugMode: boolean;
+    canTransition: boolean;
+    error?: string | undefined;
+}, {
+    isCompleted: boolean;
+    sessionId: string;
+    currentState: string;
+    transitionHistory: {
+        from: string;
+        to: string;
+        timestamp: string;
+    }[];
+    isDebugMode: boolean;
+    canTransition: boolean;
+    error?: string | undefined;
+}>;
+export type StateMachineResponseZod = z.infer<typeof StateMachineResponseZod>;
+export declare const StateMachineSessionZod: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodNativeEnum<typeof StateMachineType>;
+    persistedSnapshot: z.ZodNullable<z.ZodString>;
+    payload: z.ZodRecord<z.ZodString, z.ZodAny>;
+    debugMode: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    type: StateMachineType;
+    id: string;
+    payload: Record<string, any>;
+    debugMode: boolean;
+    persistedSnapshot: string | null;
+}, {
+    type: StateMachineType;
+    id: string;
+    payload: Record<string, any>;
+    debugMode: boolean;
+    persistedSnapshot: string | null;
+}>;
+export type StateMachineSessionZod = z.infer<typeof StateMachineSessionZod>;
+export {};