@secondstaxorg/sscomp 1.4.5 → 1.4.6

package/types/components/OffersCard/type.d.ts

@@ -1,4 +1,7 @@
 export interface OffersProps {
+    /**
+     * Array of offers to be displayed in the offers card
+     */
     offers: {
         providerName: string;
         providerLogo?: string;
@@ -11,7 +14,13 @@ export interface OffersProps {
         providerId: string;
         rate: number;
     }[];
+    /**
+     * Specify when the offers are being loaded
+     */
     loading: boolean;
+    /**
+     * Callback function for receiving the selected offer
+     */
     selectedOffer: (a: {
         providerName: string;
         providerLogo?: string;
@@ -24,5 +33,8 @@ export interface OffersProps {
         providerId: string;
         rate: number;
     }) => void;
+    /**
+     * Boolean to specify whether there's data available
+     */
     dataAvailable: boolean;
 }

package/types/components/PasswordField/PasswordField.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { PasswordFieldProps } from "./type";
+/**
+ * Component for handling password input fields
+ */
 declare const PasswordField: (props: PasswordFieldProps) => JSX.Element;
 export default PasswordField;

package/types/components/PasswordField/type.d.ts

@@ -1,8 +1,23 @@
 import React from "react";
 export interface PasswordFieldProps extends React.InputHTMLAttributes<HTMLInputElement> {
+    /**
+     * Label of the password field in the form
+     */
     label?: string;
+    /**
+     * Subtext of the label
+     */
     subtext?: string;
+    /**
+     * Specify whether the field is disabled
+     */
     disabled?: boolean;
+    /**
+     * Error message to be displayed in the case of an error
+     */
     errMsg?: string;
+    /**
+     * Placeholder text for the password field in the form
+     */
     placeholder?: string;
 }

package/types/components/PaymentMethodsTable/PaymentMethods.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { PaymentMethodsProps } from "./type";
+/**
+ * Component to display a table listing the payment methods accepted in the LP app
+ */
 declare const PaymentMethodsTable: (props: PaymentMethodsProps) => JSX.Element;
 export default PaymentMethodsTable;

package/types/components/PaymentMethodsTable/type.d.ts

@@ -1,10 +1,16 @@
 export interface PaymentMethodsProps {
+    /**
+     * Array containing a list of payment methods and their associated information
+     */
     methods: {
         pymtModeCode: string;
         pymtModeName: string;
         pymtModeShortName: string;
         remarks: string;
     }[];
+    /**
+     * Callback function to receive the selected item when clicked
+     */
     callback: (a: {
         pymtModeCode: string;
         pymtModeName: string;

package/types/components/PopupModal/PopupModal.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { PopupModalProps } from "./type";
+/**
+* Component to display a popup modal
+*/
 declare const PopupModal: (props: PopupModalProps) => JSX.Element;
 export default PopupModal;

package/types/components/PopupModal/type.d.ts

@@ -1,9 +1,30 @@
 export interface PopupModalProps {
+    /**
+     * Title of the modal
+     */
     title: string;
+    /**
+     * Content of the modal
+     */
     content: string;
+    /**
+     * Function to be called when the primary button is clicked. The primary button is the one on the right.
+     */
     primaryAction: () => void;
+    /**
+     * Text to be displayed on the primary button
+     */
     primaryBtnText: string;
+    /**
+     * Function to be called when the secondary button is clicked. When this prop is not provided, only the primary button is displayed.
+     */
     secondaryAction?: () => void;
+    /**
+     * Text to be displayed on the primary button
+     */
     secondaryBtnText?: string;
+    /**
+     * Callback function to close the modal
+     */
     closeFxn: () => void;
 }

package/types/components/ProvidersTable/ProvidersTable.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { ProvidersProps } from "./type";
+/**
+ * Component to display a table listing the providers signed on to the LP application
+ */
 declare const ProvidersTable: (props: ProvidersProps) => JSX.Element;
 export default ProvidersTable;

package/types/components/ProvidersTable/type.d.ts

@@ -1,4 +1,7 @@
 export interface ProvidersProps {
+    /**
+     * Array containing a list of providers to be listed in the table
+     */
     providers: {
         providerId: string;
         name: string;
@@ -6,6 +9,9 @@ export interface ProvidersProps {
         phone: string;
         status: Status;
     }[];
+    /**
+     * Callback function to receive the selected provider when clicked
+     */
     callback: (a: {
         providerId: string;
         name: string;

package/types/components/RateHistory/RateHistory.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { RateHistoryProps } from "./type";
+/**
+ * Component displaying cards of historical rates for a given provider in the LP application
+ */
 declare const RateHistory: (props: RateHistoryProps) => JSX.Element;
 export default RateHistory;

package/types/components/RateHistory/type.d.ts

@@ -1,4 +1,7 @@
 export interface RateHistoryProps {
+    /**
+     * An array containing list of rates and their accompanying information to be displayed in the cards
+     */
     ratePairs: {
         baseFlag: string;
         baseCurrency: string;

package/types/components/ReportsTable/type.d.ts

@@ -1,4 +1,7 @@
 export interface ReportsProps {
+    /**
+     * Array containing items to be listed in the table along with their accompanying information
+     */
     reports: {
         clientId: string;
         symbol: string;
@@ -10,6 +13,9 @@ export interface ReportsProps {
         currencyFlag: string;
         dateAdded: string;
     }[];
+    /**
+     * Callback function that passes out the selected item as an object when clicked
+     */
     callback: (selReport: {
         clientId: string;
         symbol: string;

package/types/components/RequestForm/RequestForm.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { RequestFormProps } from "./type";
+/**
+ * LP request form for selecting a symbol
+ */
 declare const RequestForm: (props: RequestFormProps) => JSX.Element;
 export default RequestForm;

package/types/components/RequestForm/type.d.ts

@@ -1,15 +1,24 @@
 export interface RequestFormProps {
+    /**
+     * Array containing symbols to be listed in the dropdown component in the form
+     */
     symbols: {
         name: string;
         shortName: string;
         countryFlag?: string;
         price: string;
     }[];
+    /**
+     * Array containing the base currencies to be exchanged from
+     */
     currencies: {
         currencyShortName: string;
         currencyLongName: string;
         countryFlag?: string;
     }[];
+    /**
+     * Callback function to pass out the selections to get the offers
+     */
     returnedData: (a: {
         symbol: string;
         quantity: number;

package/types/components/Ribbon/Ribbon.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { LinksType } from "./type";
+/**
+ * Menu item displayed at the top of the LP app containing links to different products of the SSX ecosystem
+ */
 declare const Ribbon: (props: LinksType) => JSX.Element;
 export default Ribbon;

package/types/components/Ribbon/type.d.ts

@@ -1,7 +1,13 @@
 export interface LinksType {
+    /**
+     * Array of links to be displayed in the ribbon containing the label and their respective URL
+     */
     links: {
         label: string;
         url: string;
     }[];
+    /**
+     * Background colour of the ribbon when rendered
+     */
     bgColor: 'dark' | 'light';
 }

package/types/components/SearchBar/SearchBar.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { SearchProps } from "./type";
+/**
+ * A search field added on the news application to implement search
+ */
 declare const SearchBar: (props: SearchProps) => JSX.Element;
 export default SearchBar;

package/types/components/SearchBar/type.d.ts

@@ -1,5 +1,11 @@
 import React from "react";
 export interface SearchProps extends React.HTMLAttributes<any> {
+    /**
+     * Value of string being entered
+     */
     value?: string;
+    /**
+     * Function to be called when the search button is clicked
+     */
     submitFxn: Function;
 }

package/types/components/SearchResultsBar/SearchResultsBar.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { NewsBarProps } from "./type";
+/**
+ * Bar displayed for search results
+ */
 declare const SearchResultsBar: (props: NewsBarProps) => JSX.Element;
 export default SearchResultsBar;

package/types/components/SearchResultsBar/type.d.ts

@@ -1,5 +1,14 @@
 export interface NewsBarProps {
+    /**
+     * Title to be displayed as the title of the search
+     */
     title: string;
+    /**
+     * Number of hits from the search
+     */
     totalRes?: number;
+    /**
+     * Number of items from the total that are being displayed
+     */
     resultsDisplayed?: number;
 }

package/types/components/Selector/types.d.ts

@@ -1,8 +1,14 @@
 export interface SelectorProps {
+    /**
+     * Array containing items to be listed in the component
+     */
     itemsList: {
         value?: string;
         label: string;
     }[];
+    /**
+     * Callback function passing out the selected item when clicked
+     */
     selectedItem: (a: {
         label: string;
         value?: string;

package/types/components/SmallNewsCard/SmallNewsCard.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { SmallNewsCardProps } from "./type";
+/**
+ * News cards displayed on the right side of the news page
+ */
 declare const SmallNewsCard: (props: SmallNewsCardProps) => JSX.Element;
 export default SmallNewsCard;

package/types/components/SmallNewsCard/type.d.ts

@@ -1,9 +1,30 @@
 export interface SmallNewsCardProps {
+    /**
+     * ID of the news item
+     */
     id: string;
+    /**
+     * Title of the news item
+     */
     title: string;
+    /**
+     * URL to the featured of the news item
+     */
     featuredImgUrl: string;
+    /**
+     * Source of the news item
+     */
     source: string;
+    /**
+     * Date when the news item was published
+     */
     date: string;
+    /**
+     * URL to the flag of the source country
+     */
     sourceCountryFlagUrl: string;
+    /**
+     * URL to the news item
+     */
     storyUrl: string;
 }

package/types/components/StatusBadge/StatusBadge.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { statusProps } from "./type";
+/**
+ * Badges to displayed to show the status of something
+ */
 declare const StatusBadge: (props: statusProps) => JSX.Element;
 export default StatusBadge;

package/types/components/StatusBadge/type.d.ts

@@ -1,5 +1,14 @@
 export interface statusProps {
+    /**
+     * The status of the item
+     */
     status: 'default' | 'warning' | 'primary' | 'neutral' | 'success' | 'error';
+    /**
+     * Label of the status
+     */
     label: string;
+    /**
+     * How wide should the badge be
+     */
     width?: number;
 }

package/types/components/StocksTicker/StocksTicker.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { StocksType } from "./type";
+/**
+ * Component to display a ticker of stocks
+ */
 declare const StocksTicker: (props: StocksType) => JSX.Element;
 export default StocksTicker;

package/types/components/StocksTicker/type.d.ts

@@ -1,4 +1,7 @@
 export interface StocksType {
+    /**
+     * Array of stocks to be run in the ticker
+     */
     stocksData: {
         symbolName: string;
         symbolShortName: string;

package/types/components/SystemConfigTable/SystemConfigTable.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { SystemConfigProps } from "./type";
+/**
+ * Table displaying the configurations of the system in the LP application
+ */
 declare const SystemConfigTable: (props: SystemConfigProps) => JSX.Element;
 export default SystemConfigTable;

package/types/components/SystemConfigTable/type.d.ts

@@ -1,10 +1,21 @@
 export interface SystemConfigProps {
+    /**
+     * Array of configurations and their associated data
+     */
     configs: {
         configCode: string;
         configName: string;
         configValue: string;
         remarks: string;
     }[];
-    callback: any;
+    /**
+     * Callback function to pass out the object of the selected item when clicked
+     */
+    callback: (a: {
+        configCode: string;
+        configName: string;
+        configValue: string;
+        remarks: string;
+    }) => void;
     srchActive?: boolean;
 }

package/types/components/Tab/Tab.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { TabType } from "./type";
+/**
+ * Component to generate a tabbed view of content
+ */
 declare const Tab: (props: TabType) => JSX.Element;
 export default Tab;

package/types/components/Tab/type.d.ts

@@ -1,11 +1,23 @@
 import { ReactNode } from "react";
 export interface TabType {
+    /**
+     * Array of tabs and their associated component content
+     */
     tabs: {
         tabName: string;
         tabComponent: ReactNode;
         activeBgHexColor?: string;
     }[];
+    /**
+     * Background of the tabs
+     */
     bgHexColor?: string;
+    /**
+     * Color of an inactive tab
+     */
     inactiveTabBgHexColor?: string;
+    /**
+     * Callback function returning the value of the currently active tab when selected
+     */
     selectedTab?: (a: string | number) => void;
 }

package/types/components/TextArea/TextArea.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { TextAreaProps } from "./type";
+/**
+ * Component to display a textarea field in a form. This mimics the behavior of a regular HTML <code>&lt;textarea&gt;</code> element and accepts the same props as it along with the custom ones defined.
+ */
 declare const TextArea: (props: TextAreaProps) => JSX.Element;
 export default TextArea;

package/types/components/TextArea/type.d.ts

@@ -1,7 +1,19 @@
 import React from "react";
 export interface TextAreaProps extends React.TextareaHTMLAttributes<HTMLTextAreaElement> {
+    /**
+     * Label of the field to be displayed in the form
+     */
     label?: string;
+    /**
+     * Subtext of the label
+     */
     subtext?: string;
+    /**
+     * Error message to be displayed in the case of an error
+     */
     errMsg?: string;
+    /**
+     * Initial value to be displayed
+     */
     initialVal?: string | number;
 }

package/types/components/TextField/TextField.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { TextFieldProps } from "./type";
+/**
+ * Component to display an input field component in a form. This mimics the behavior of a regular HTML <code>&lt;input&gt;</code> element and accepts the same props as it along with the custom ones defined.
+ */
 declare const TextField: (props: TextFieldProps) => JSX.Element;
 export default TextField;

package/types/components/TextField/type.d.ts

@@ -1,7 +1,19 @@
 import React from "react";
 export interface TextFieldProps extends React.InputHTMLAttributes<HTMLInputElement> {
+    /**
+     * Label of the input field
+     */
     label?: string;
+    /**
+     * Subtext of the label
+     */
     subtext?: string;
+    /**
+     * Error message to be displayed in the case of an error
+     */
     errMsg?: string;
+    /**
+     * The initial value of the field to be displayed in the component
+     */
     initialVal?: string | number;
 }

package/types/components/TransactionDetails/TransactionDetails.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { TxnDetsProps } from "./type";
+/**
+ * Component to display the details of a transaction when selected from the transactions list table
+ */
 declare const TransactionDetails: (props: TxnDetsProps) => JSX.Element;
 export default TransactionDetails;

package/types/components/TransactionDetails/type.d.ts

@@ -1,7 +1,19 @@
 export interface TxnDetsProps {
+    /**
+     * Name of user who made the transaction
+     */
     requestedBy: string;
+    /**
+     * Date when the transaction took place
+     */
     requestDate: string;
+    /**
+     * Client ID for use by the broker for their internal identification of transactions
+     */
     clientID?: string;
+    /**
+     * The amount involved in the transaction in both the base currency and the exchange currency
+     */
     amount: {
         baseAmount: number;
         baseFlag: string;
@@ -11,10 +23,16 @@ export interface TxnDetsProps {
         exchCurr: string;
         exchRate: number;
     };
+    /**
+     * The provider selected at the time of transaction
+     */
     provider: {
         name: string;
         logo?: string;
     };
+    /**
+     * Details of the destination bank account where the exchanged funds will be deposited
+     */
     destAcctDets?: {
         bankLogo?: string;
         acctNo: number;

package/types/components/TransactionDetailsWithPayment/TransactionDetailsWithPayment.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { TxnDetsWPymntProps } from "./type";
+/**
+ * Component to display the details of a transaction along with payment information after the broker has sent the base amount to the provider when selected from the transactions list table
+ */
 declare const TransactionDetailsWithPayment: (props: TxnDetsWPymntProps) => JSX.Element;
 export default TransactionDetailsWithPayment;

package/types/components/TransactionDetailsWithPayment/type.d.ts

@@ -1,6 +1,15 @@
 export interface TxnDetsWPymntProps {
+    /**
+     * Name of user who made the request
+     */
     requestedBy: string;
+    /**
+     * Date when the transaction occurred
+     */
     requestDate: string;
+    /**
+     * Amount involved in the transaction in the base currency and exchange currency
+     */
     amount: {
         baseAmount: number;
         baseFlag: string;
@@ -10,10 +19,16 @@ export interface TxnDetsWPymntProps {
         exchCurr: string;
         exchRate: number;
     };
+    /**
+     * Provider selected at the time of the transaction and URL to their corresponding logo
+     */
     provider: {
         name: string;
         logo?: string;
     };
+    /**
+     * Payment details from the payment that the broker made to the provider
+     */
     paymentDets: {
         payeeName: string;
         bankCountry: string;

package/types/components/UpdateUserActions/UpdateUserActions.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { UpdateUserActionsProps } from "./type";
+/**
+ * Component to handle the update of user actions in the LP application
+ */
 declare const UpdateUserActions: (props: UpdateUserActionsProps) => JSX.Element;
 export default UpdateUserActions;

package/types/components/UpdateUserActions/type.d.ts

@@ -1,14 +1,29 @@
 export interface UpdateUserActionsProps {
+    /**
+     * Array of options available to the user
+     */
     availableOptions: {
         optionName: string;
         optionId: string;
     }[];
+    /**
+     * Array of options that the user currently has under their account
+     */
     currentOptions: {
         optionName: string;
         optionId: string;
     }[];
+    /**
+     * Title for available options
+     */
     titleAvailable?: string;
+    /**
+     * Title for current options
+     */
     titleCurrent?: string;
+    /**
+     * Callback function to handle the selected options that were added for the user or removed
+     */
     selOptions: (a: {
         added: [];
         removed: [];

package/types/components/UserActions/UserActions.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { UserActionsProps } from "./type";
+/**
+ * Component to handle tha addition of user actions for a user in the LP application
+ */
 declare const UpdateUserActions: (props: UserActionsProps) => JSX.Element;
 export default UpdateUserActions;