Type References

type IItem = {
   address: string;
   tokenId: string;
   itemType: ItemType;
   amount: number;
   isAutoLiquidated: boolean;
   existingPlanId?: number;
   privateSaleId?: number;
};

/** 
The `IItemWithPrice` type extends the `IItem` type by including additional field for item price.
*/

type IItemWithPrice = IItem & {
   price: {
       amount: BigNumber;
       currency: string;
   };
};

/** 
The `IItemWithSelectedLoanOption` type extends the `IItem` type by including additional fields for pricing,
a loan option, and optional fields for existing plan ID and private sale ID.
*/

type IItemWithLoanOption = IItem & {
    price: BigNumber;
    option: IOption;
    existingPlanId?: number;
    privateSaleId?: number;
}

type ISdkPricerStep1Result = {
    items: Array<IItem & { 
        price: BigNumber; 
        interestRate: number; 
        options: IOption[] 
    }>;
}

/** 
The `IPricedItemWithPlan` type extends the `ICreatePlanParams` type by including additional fields 
to indicate changes and optional market information.
*/

type IPricedItemWithPlan = Errored<ICreatePlanParams & { isChanged: boolean; marketName?: string }>

type ICreatePlanParams = {
  item: {
        amount: number;
        tokenId: string;
        contractAddress: string;
        cyanVaultAddress: string;
        itemType: ItemType;
    };
    plan: {
        amount: BigNumber;
        downPaymentPercent: number;
        interestRate: number;
        serviceFeeRate: number;
        term: number;
        totalNumberOfPayments: number;
        counterPaidPayments: number;
        autoRepayStatus: AutoRepayStatus;
    };
    planId: number;
    blockNum: number;
    signature: string;
}

type IOption = {
  term: number;
  loanRate: number;

  totalNumberOfPayments: number;
  interestRate: number;
  serviceFeeRate: number;
  downpaymentRate: number;
  counterPaidPayments: number;

  downpaymentAmount: BigNumber;
  monthlyAmount: BigNumber;
}

enum AutoRepayStatus {
    Disabled = 0,
    FromCyanWallet = 1,
    FromMainWallet = 2,
}

const PlanTypes = {
    bnpl: 0,
    pawn: 1,
} as const;
type IPlanType = typeof PlanTypes[keyof typeof PlanTypes];

const statusType = {
  Pending: 0,
  Funded: 1,
  Activated: 2,
};
export interface IPlanStatus = typeof statusType[keyof typeof statusType];

interface IPlan {
  planId: number;
  owner: string;
  totalNumOfPayments: number;
  currentNumOfPayments: number;
  status: IPlanStatus;
  type: 'bnpl' | 'pawn';
  paymentPlanContractAddress: string;
  collectionAddress: string;
  autoRepayStatus: AutoRepayStatus;
  tokenId: string;
}

export type IOffer = {
    hash: string;
    contract: string;
    price: {
        currency: {
            contract: string;
            decimals: number;
            symbol: string;
            name: string;
        };
        amount: {
            raw: string;
            decimal: number;
        };
        netAmount: {
            raw: string;
            decimal: number;
        };
    };
    validUntil: number;
}

/** The `ICollectionsWithMaxLtvs` type represents an array of collection objects, each containing 
    information about the maximum loan-to-value (LTV) ratios for different currencies.
*/

type ICollectionsWithMaxLtvs = {
    address: string;
    maxLtvs: {
        currencyAddress: string;
        maxLtv: number;
    }[];
}[];