@secondstaxorg/sscomp 1.4.1 → 1.4.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@secondstaxorg/sscomp",
-  "version": "1.4.01",
+  "version": "1.4.3",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },

package/types/components/ActionFailed/ActionFailed.d.ts

@@ -1,7 +1,4 @@
 /// <reference types="react" />
 import { ActionFailedProps } from "./type";
-/**
- * Solid button
- */
 export declare const ActionFailed: (props: ActionFailedProps) => JSX.Element;
 export default ActionFailed;

package/types/components/ActionSuccess/ActionSuccess.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { ActionSuccessProps } from "./type";
+/**
+ * Message status of an action whether it succeeded or failed.
+ */
 declare const ActionSuccess: (props: ActionSuccessProps) => JSX.Element;
 export default ActionSuccess;

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

@@ -1,4 +1,10 @@
 export interface ActionSuccessProps {
+    /**
+     * Main optional text as the title of the status
+     */
     headingText?: string;
+    /**
+     * Optional sub text as the actual message of the status
+     */
     subText?: string;
 }

package/types/components/AppActionsTable/AppActionsTable.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { AppActionsProps } from "./type";
+/**
+ * Table view of App Actions on Code Maintenance in LP Application
+ */
 declare const AppActionsTable: (props: AppActionsProps) => JSX.Element;
 export default AppActionsTable;

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

@@ -1,10 +1,16 @@
 export interface AppActionsProps {
+    /**
+     * Array with objects containing the title of the app action, the description, clearance level and action code to be passed to the component
+     */
     actions: {
         title: string;
         description: string;
         clearanceLevel: number;
         actionCode: string;
     }[];
+    /**
+     * Callback function that is passed to the component to receive the selected row of app actions from the table when clicked.
+     */
     callback: (a: {
         title: string;
         description: string;

package/types/components/AppFormsTable/AppFormsTable.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { AppFormsProps } from "./type";
+/**
+ * Table view of App Actions on Code Maintenance in LP Application
+ */
 declare const AppFormsTable: (props: AppFormsProps) => JSX.Element;
 export default AppFormsTable;

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

@@ -1,9 +1,15 @@
 export interface AppFormsProps {
+    /**
+     * Array with objects containing the title of the form name, form code and user type to be passed to the component
+     */
     forms: {
         formName: string;
         formCode: string;
         userType: string;
     }[];
+    /**
+     * Callback function that is passed to the component to receive the selected row of app forms from the table when clicked.
+     */
     callback: (a: {
         formName: string;
         formCode: string;

package/types/components/AppModulesTable/AppModulesTable.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { AppModulesProps } from "./type";
+/**
+ * Table view of App Modules in Code Maintenance in LP Application
+ */
 declare const AppModulesTable: (props: AppModulesProps) => JSX.Element;
 export default AppModulesTable;

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

@@ -1,9 +1,15 @@
 export interface AppModulesProps {
+    /**
+     * Array with objects containing the title of the module name, module code and remarks to be passed to the component
+     */
     modules: {
         moduleName: string;
         moduleCode: string;
         remarks: string;
     }[];
+    /**
+     * Callback function that is passed to the component to receive the selected row of app module from the table when clicked.
+     */
     callback: (a: {
         moduleName: string;
         moduleCode: string;

package/types/components/AuditLog/AuditLog.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { AuditProps } from "./type";
+/**
+ * This component lists out activities that has been performed on a certain module in Code Maintenance on the LP application.
+ */
 declare const AuditLog: (props: AuditProps) => JSX.Element;
 export default AuditLog;

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

@@ -1,4 +1,7 @@
 export interface AuditProps {
+    /**
+     * An array containing objects detailing the timestamp, the user, the description of the action and an optional reference ID for the action.
+     */
     logDetails: {
         timestamp: string;
         user: string;

package/types/components/BankAccounts/BankAccounts.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { BankAcctsProps } from "./type";
+/**
+ * This component displays a list of bank accounts associated with a provider or broker.
+ */
 declare const BankAccounts: (props: BankAcctsProps) => JSX.Element;
 export default BankAccounts;

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

@@ -1,4 +1,8 @@
 export interface BankAcctsProps {
+    /**
+     * Array to be passed to the component containing objects with account number, bank name, account name, currency, swift code, a boolean to tell if the account is active, if it's the main account
+     * the logo for the bank, callback function for editing the bank account, callback function for deactivating the account and a call bak function to reactivate the account.
+     */
     acctDets: {
         acctNumber: number;
         bankName: string;
@@ -12,5 +16,8 @@ export interface BankAcctsProps {
         deactivateFxn: (a?: any) => void;
         reactivateFxn: (a?: any) => void;
     }[];
+    /**
+     * A boolean to disable the action buttons for each bank account when an action such as getting the details of one of them is still in progress.
+     */
     loading: boolean;
 }

package/types/components/BankSelector/BankSelector.d.ts

@@ -1,4 +1,8 @@
 /// <reference types="react" />
 import { BankSelectorProps } from "./type";
+/**
+ * In the LP application, when making an LP request, there is a stage in the process where the broker will need to select the bank account into which to receive the exchanged funds.
+ * This is the component that handles the selection of the bank account.
+ */
 declare const BankSelector: (props: BankSelectorProps) => JSX.Element;
 export default BankSelector;

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

@@ -1,4 +1,7 @@
 export interface BankSelectorProps {
+    /**
+     * Array with objects containing the optional bank logo, account number, name of the bank, name on the account and the account currency that is passed to the component.
+     */
     bankAcct: {
         bankLogo?: string;
         acctNo: number;
@@ -6,6 +9,9 @@ export interface BankSelectorProps {
         acctName: string;
         currency: string;
     }[];
+    /**
+     * Callback function that is passed to the component to receive the object of selected bank account with the account number, bank name, account name and account currency passed out as the information.
+     */
     selectedBank: (a: {
         bankLogo?: string;
         acctNo: number;

package/types/components/BreadcrumbBar/BreadcrumbBar.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { BreadcrumbType } from "./type";
+/**
+ * The breadcrumb component lists out the path (with page names) to the page you're on
+ */
 declare const BreadcrumbBar: (props: BreadcrumbType) => JSX.Element;
 export default BreadcrumbBar;

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

@@ -1,5 +1,8 @@
 import React from "react";
 export interface BreadcrumbType extends React.HTMLAttributes<any> {
+    /**
+     * Array of object containing the label and url of all the individual pages that should be listed in the breadcrumb.
+     */
     pages: {
         label: string;
         url?: string;

package/types/components/BrokersTable/BrokersTable.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { BrokersProps } from "./type";
+/**
+ * A list of all brokers that have been registered on to the LP platform
+ */
 declare const BrokersTable: (props: BrokersProps) => JSX.Element;
 export default BrokersTable;

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

@@ -1,4 +1,7 @@
 export interface BrokersProps {
+    /**
+     * Array containing objects with each broker by the broker ID, the broker name, email, phone, country and optional country flag
+     */
     brokers: {
         brokerId: string;
         name: string;
@@ -7,6 +10,9 @@ export interface BrokersProps {
         country: string;
         countryFlag?: string;
     }[];
+    /**
+     * Callback function that returns the selected broker from the table with their associated information
+     */
     callback: (a: {
         brokerId: string;
         name: string;

package/types/components/Button/Button.d.ts

@@ -1,22 +1,5 @@
-import React from "react";
-interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
-    /**
-     * Colour variant of the button
-     */
-    variant?: 'primary' | 'error' | 'warning' | 'success';
-    /**
-     * Size of the button. Whether large, medium or small
-     */
-    size: 'lg' | 'md' | 'sm';
-    /**
-     * State of the button. Whether disabled or not.
-     */
-    disabled?: boolean;
-    /**
-     * HTML or text content of the button. Essentially the label.
-     */
-    children: any;
-}
+/// <reference types="react" />
+import { ButtonProps } from "./type";
 /**
  * Solid and Outline buttons
  */

package/types/components/Chart/Chart.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { ChartProps } from "./type";
+/**
+ * This component displays a historical chart of currency performance between selected currencies.
+ */
 declare const Chart: (props: ChartProps) => JSX.Element;
 export default Chart;

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

@@ -1,4 +1,7 @@
 export interface ChartProps {
+    /**
+     * Array containing objects of the rate data, which contain the base and exchange currency, rate, the date of the rate and the percentage change in the rate.
+     */
     ratesData: {
         baseCurrency: string;
         exchCurrency: string;
@@ -6,8 +9,20 @@ export interface ChartProps {
         currDate: string;
         rateChange: number;
     }[];
+    /**
+     * URL to the flag of the exchange currency
+     */
     exchCurrFlag: string;
+    /**
+     * Name of exchange currency
+     */
     exchCurrName: string;
+    /**
+     * Currency code of exchange currency
+     */
     exchCurrCode: string;
+    /**
+     * Currency code of base currency
+     */
     baseCurrCode: string;
 }