@secondstaxorg/sscomp 1.4.5 → 1.4.6

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

@@ -1,18 +1,36 @@
 export interface UserActionsProps {
+    /**
+     * Options that are available to be added for the user
+     */
     availableOptions: {
         optionName: string;
         optionId: string;
     }[];
+    /**
+     * Options that are currently available to the user under their account on the LP application
+     */
     currentOptions: {
         optionName: string;
         optionId: string;
     }[];
+    /**
+     *  Options that are currently available to them that can be removed
+     */
     supplementaryOptions: {
         optionName: string;
         optionId: string;
     }[];
+    /**
+     * Title for the available options
+     */
     titleAvailable?: string;
+    /**
+     * Title for the current options
+     */
     titleCurrent?: string;
+    /**
+     * Callback function containing options that were added or removed for the user
+     */
     selOptions: (a: {
         added: [];
         removed: [];

package/types/components/UserRolesTable/UserRolesTable.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { UserRolesProps } from "./type";
+/**
+ * Table listing the user roles that can be assigned to users in the LP application
+ */
 declare const UserRolesTable: (props: UserRolesProps) => JSX.Element;
 export default UserRolesTable;

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

@@ -1,9 +1,15 @@
 export interface UserRolesProps {
+    /**
+     * Array containing all the roles to be displayed in the table
+     */
     roles: {
         roleName: string;
         roleCode: string;
         clearanceLevel: number;
     }[];
+    /**
+     * Callback function that passes out the selected item when clicked
+     */
     callback: (a: {
         roleName: string;
         roleCode: string;

package/types/components/UsersTable/UsersTable.d.ts

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

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

@@ -1,4 +1,7 @@
 export interface UserTableType {
+    /**
+     * Array containing all users and their accompanying information to be listed in the table
+     */
     users: {
         name: string;
         organisation: string;
@@ -7,6 +10,15 @@ export interface UserTableType {
         status: string;
         userId: string;
     }[];
-    callback: any;
+    /**
+     * Callback function that passes out the selected item as an object when clicked
+     */
+    callback: (a: {
+        name: string;
+        organisation: string;
+        email: string;
+        role: string;
+        status: string;
+    }) => void;
     srchActive?: boolean;
 }

package/types/components/WidgetTitle/WidgetTitle.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { WidgetTitleProps } from "./type";
+/**
+ * Component that displays the title of a widget on the right side of the news application
+ */
 declare const WidgetTitle: (props: WidgetTitleProps) => JSX.Element;
 export default WidgetTitle;

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

@@ -1,4 +1,7 @@
 import React from "react";
 export interface WidgetTitleProps extends React.HTMLAttributes<any> {
+    /**
+     * Title of the widget
+     */
     title: string;
 }