@carefirst/library 8.0.1 → 8.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carefirst/library",
-  "version": "8.0.1",
+  "version": "8.1.0",
   "author": "FCS Dev Team",
   "private": false,
   "peerDependencies": {

package/public/interfaces/carefirst.shared.interfaces.ts

@@ -1,14 +1,10 @@
 /**
  * Carefirst Shared Global Interfaces
- *
  * @file          carefirst.shared.interfaces
- * @description   Interfaces for various globally shared data sets used in Carefirst
- * @author        Jacques Coetzee
- * @since         2021 - 11 - 16
+ * @description Interfaces for various globally shared data sets used in Carefirst
  */
 
-/**==============================================
- * @name         globalVariablesC
+/** =============================================
  * @description  Globally accessible variables used throughout various parts
  */
 export const globalVariablesC = {
@@ -36,8 +32,7 @@ export const globalVariablesC = {
   fnbAccountTypesC: ['0', '1', '2', '3', '4', '6', 'D', 'S', 'F', 'W'],
 } as const;
 
-/**==============================================
- * @name         GlobalTypesT
+/** =============================================
  * @description  Globally accessible types used throughout various parts
  */
 export interface GlobalTypesT {
@@ -60,9 +55,8 @@ export interface GlobalTypesT {
   fnbAccountTypesT: (typeof globalVariablesC.fnbAccountTypesC)[number];
 }
 
-/**==============================================
- * @name          AccessIdentifiersT
- * @description   Available identifiers as defined in DB
+/** =============================================
+ * @description Available identifiers as defined in DB
  */
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const availableUserRoleIdentifiersC = [
@@ -94,16 +88,18 @@ const availableUserRoleIdentifiersC = [
   'routeToolLMSErrors',
   'routeDashboardLMSOverview',
 ] as const;
+
+/** =============================================
+ * @description Access identifiers type
+ */
 export type AccessIdentifiersT = (typeof availableUserRoleIdentifiersC)[number];
 
-/**==============================================
- * @name          GenericHistoricTimeFrames
- * @description   Generic type created from dashboardTimeFrames
+/** =============================================
+ * @description Generic type created from dashboardTimeFrames
  */
 export type GenericHistoricTimeFrames<Type> = Record<GlobalTypesT['dashboardHistoricTimeframeTypeT']['property'], Type>;
 
-/**==============================================
- * @interface    SingleValueDataI
+/** =============================================
  * @description  SingeValue data type
  */
 export interface SingleValueDataI {
@@ -124,16 +120,14 @@ export interface SingleValueDataI {
   };
 }
 
-/**==============================================
- * @interface    SingleValueTimeFrameDataI
+/** =============================================
  * @description  SingeValue data type with timeframe breakdown
  */
 export interface SingleValueTimeFrameDataI extends Omit<SingleValueDataI, 'value'> {
   value: GenericHistoricTimeFrames<SingleValueDataI['value']>;
 }
 
-/**==============================================
- * @interface    PatientRatingDataI
+/** =============================================
  * @description  Patient rating type
  */
 export interface PatientRatingDataI extends Omit<SingleValueDataI, 'value'> {
@@ -144,16 +138,14 @@ export interface PatientRatingDataI extends Omit<SingleValueDataI, 'value'> {
   };
 }
 
-/**==============================================
- * @interface    PatientRatingTimeFrameDataI
+/** =============================================
  * @description  Patient rating per timeframe type
  */
 export interface PatientRatingTimeFrameDataI extends Omit<PatientRatingDataI, 'value'> {
   value: GenericHistoricTimeFrames<PatientRatingDataI['value']>;
 }
 
-/**==============================================
- * @interface    ChartDataI
+/** =============================================
  * @description  Chart data type
  */
 export interface ChartDataI {
@@ -162,16 +154,14 @@ export interface ChartDataI {
   source: [string, ...number[]][]; //--- Each element contains a data point of type ['label', number1, number2, ...]
 }
 
-/**==============================================
- * @interface    ChartTimeFrameDataI
+/** =============================================
  * @description  Chart data type with timeframe breakdown
  */
 export interface ChartTimeFrameDataI extends Omit<ChartDataI, 'source'> {
   source: GenericHistoricTimeFrames<ChartDataI['source']>;
 }
 
-/**==============================================
- * @interface    GanttChartTemplateDataI
+/** =============================================
  * @description  Gantt chart data type as sent by backend directly to frontend template
  */
 export interface GanttChartTemplateDataI {
@@ -193,8 +183,7 @@ export interface GanttChartTemplateDataI {
   };
 }
 
-/**==============================================
- * @interface    TableDiagnosesProceduresDataI
+/** =============================================
  * @description  Table entry data type for both diagnoses and procedures
  */
 export type TableDiagnosesProceduresDataI = {
@@ -204,15 +193,13 @@ export type TableDiagnosesProceduresDataI = {
   percentageOfTotal: number;
 }[];
 
-/**==============================================
- * @interface    TableDiagnosesProceduresTimeFrameDataI
+/** =============================================
  * @description  Table data type for Diagnoses and Procedures with timeframe breakdown
  */
 export type TableDiagnosesProceduresTimeFrameDataI = GenericHistoricTimeFrames<TableDiagnosesProceduresDataI>;
 
-/**==============================================
- * @interface     DataTableTemplateDataI
- * @description   Table data type as sent by backend directly to frontend template
+/** =============================================
+ * @description Table data type as sent by backend directly to frontend template
  */
 export interface DataTableTemplateDataI {
   tableSetup: {
@@ -233,18 +220,29 @@ export interface DataTableTemplateDataI {
   rowData: Record<string, unknown>[]; //--- Array of objects containing row data
 }
 
-/**==============================================
- * @interface    FileUploadFormDataFieldPayloadI
+/** =============================================
  * @description  Defines the field payload part of the FormData sent to the backend for uploading files
  */
 export type FileUploadFormDataFieldPayloadI = FileUploadFormDataFieldUnitsPayloadI[] | FileUploadFormDataFieldUsersPayloadI[];
+
+/** =============================================
+ * @description  Defines the base fields for the file upload form data field payload
+ */
 interface FileUploadFieldBaseI {
   fileName: string;
   fileType: number;
 }
+
+/** =============================================
+ * @description  Defines the base fields for the file upload form data field payload
+ */
 export interface FileUploadFormDataFieldUnitsPayloadI extends FileUploadFieldBaseI {
   unitId: number;
 }
+
+/** =============================================
+ * @description  Defines the base fields for the file upload form data field payload
+ */
 export interface FileUploadFormDataFieldUsersPayloadI extends FileUploadFieldBaseI {
   userId: number;
 }

package/public/styles/index.scss

@@ -2,10 +2,7 @@
  * CareFirst CSS Index File
  *
  * @file          index.scss
- * @description   Contains all the base CSS files pertaining to the CareFirst Design theme
- * @author        Jacques Coetzee
- * @since         2023 - 09 - 04
- * @usage         @forward "../node_modules/@carefirst/library/styles/index.scss";
+ * @description Contains all the base CSS files pertaining to the CareFirst Design theme
                   Add to angular.json - "stylePreprocessorOptions": {"includePaths": ["node_modules/@carefirst/library/public/styles/stylePreprocessorOptions"]}
  */