wed-components-beta 0.0.1

package/README.md

@@ -0,0 +1,50 @@
+# React + TypeScript + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+
+## Expanding the ESLint configuration
+
+If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+
+- Configure the top-level `parserOptions` property like this:
+
+```js
+export default tseslint.config({
+  languageOptions: {
+    // other options...
+    parserOptions: {
+      project: ['./tsconfig.node.json', './tsconfig.app.json'],
+      tsconfigRootDir: import.meta.dirname,
+    },
+  },
+})
+```
+
+- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
+- Optionally add `...tseslint.configs.stylisticTypeChecked`
+- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
+
+```js
+// eslint.config.js
+import react from 'eslint-plugin-react'
+
+export default tseslint.config({
+  // Set the react version
+  settings: { react: { version: '18.3' } },
+  plugins: {
+    // Add the react plugin
+    react,
+  },
+  rules: {
+    // other rules...
+    // Enable its recommended rules
+    ...react.configs.recommended.rules,
+    ...react.configs['jsx-runtime'].rules,
+  },
+})
+```

package/dist/Accordion/Accordion.d.ts

@@ -0,0 +1,11 @@
+import { CSSProperties, ReactNode } from 'react';
+type CourseProgressionCard = {
+    children: ReactNode;
+    containerStyles?: CSSProperties;
+    id?: string;
+    onClick: () => void;
+    open: boolean;
+    title: ReactNode;
+};
+export declare function Accordion({ children, containerStyles, id, onClick, open, title }: CourseProgressionCard): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/CourseProgressionTable/CourseProgressionTable.d.ts

@@ -0,0 +1,38 @@
+type CourseProgression = {
+    affiliation_name: string | null;
+    base_course_credit_default: number;
+    base_course_name: string;
+    comments: string | null;
+    course_type_name: string;
+    course_type_tag: string;
+    credit_type_name: string;
+    credit_type_tag: string;
+    fk_id_affiliation: number | null;
+    fk_id_base_course: number;
+    fk_id_course_type: number;
+    fk_id_credit_type: number;
+    fk_id_request_course_progression_type?: number;
+    fk_id_term: number;
+    id?: number;
+    is_group_classes: boolean | null;
+    is_self_paced: boolean | null;
+    is_private: boolean | null;
+    term_name: string;
+    weeks: number | null;
+};
+type Props = {
+    selectedTheme?: 'light' | 'dark';
+    courseProgression: {
+        year: number;
+        courseProgression: [CourseProgression[], CourseProgression[]];
+    }[] | null;
+    totalCredits: number;
+    renderCommentIcon: (comments: string) => JSX.Element;
+    renderCourseWithWED: (affiliation_name: string | null) => JSX.Element;
+    renderDeleteButton?: (id: number | null, fk_id_request_course_progression_type: number | null, fk_id_base_course: number, fk_id_term: number) => JSX.Element;
+    renderGroupClassesIcon: () => JSX.Element;
+    renderPrivateIcon: () => JSX.Element;
+    renderSelfPacedIcon: () => JSX.Element;
+};
+export declare function CourseProgressionTable({ selectedTheme, courseProgression, totalCredits, renderCommentIcon, renderCourseWithWED, renderDeleteButton, renderGroupClassesIcon, renderPrivateIcon, renderSelfPacedIcon }: Props): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/DocumentRenderer/DocumentRenderer.d.ts

@@ -0,0 +1,25 @@
+type DocumentProps = {
+    /** State that represents the amount of zoom. */
+    zoom?: number;
+    /**
+     * setState function to handle the zoom state.
+     * @param direction - Define how much zoom should be applied to each direction (5%, 10%, 25%, etc.)
+     * @returns - void
+     */
+    handleZoom?: (direction: 'decrease' | 'augment') => void;
+    /** Helper text displayed when no children are passed down as props (use conditional ternary operator) */
+    helperText?: string;
+    /**
+     * Function used to download the children
+     * @returns - void
+     */
+    onDownload?: () => void;
+    /** Boolean used to disable the download button and hide the zoom controller */
+    disabled: boolean;
+    /** Documents to be displayed */
+    children: any;
+    /** Number of documents being displayed */
+    numberOfDocuments?: number;
+};
+export declare function DocumentRenderer({ zoom, helperText, disabled, onDownload, children, numberOfDocuments }: DocumentProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/DocumentViewer/DocumentViewer.d.ts

@@ -0,0 +1,3 @@
+export declare function DocumentViewer({ src }: {
+    src: string;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/RightSidePanel/RightSidePanel.d.ts

@@ -0,0 +1,11 @@
+type RightSidePanelProps = {
+    children?: any;
+    footer?: any;
+    maxWidth?: 'sm' | 'md' | 'lg' | 'xl' | 'xxl';
+    onClose: () => void;
+    state: boolean;
+    theme?: 'dark' | 'light';
+    title: any;
+};
+export declare function RightSidePanel({ children, footer, maxWidth, onClose, state, theme, title }: RightSidePanelProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/Table/BodyContainer.d.ts

@@ -0,0 +1,13 @@
+import { CSSProperties } from 'react';
+type BodyContainerProps = {
+    allowCellOverflow?: boolean;
+    children: any;
+    flexGrow?: number;
+    flexShrink?: number;
+    id?: string;
+    maxWidth?: number | string;
+    onScroll?: (e: React.UIEvent<HTMLDivElement, UIEvent>) => void;
+    style?: CSSProperties;
+};
+export declare function BodyContainer({ allowCellOverflow, children, flexGrow, flexShrink, maxWidth, id, onScroll, style }: BodyContainerProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/Table/Cell.d.ts

@@ -0,0 +1,10 @@
+import { CSSProperties } from 'react';
+type CellProps = {
+    children: any;
+    flexGrow?: boolean;
+    onClick?: () => void;
+    style?: CSSProperties;
+    width?: number;
+};
+export declare function Cell({ children, flexGrow, onClick, style, width }: CellProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/Table/ExpansibleRow.d.ts

@@ -0,0 +1,10 @@
+import { CSSProperties } from 'react';
+type BodyRowProps = {
+    children: any;
+    state: boolean;
+    onClick?: any;
+    nestingLevel?: 1 | 2 | 3;
+    style?: CSSProperties;
+};
+export declare function ExpansibleRow({ children, state, onClick, nestingLevel, style }: BodyRowProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/Table/Footer.d.ts

@@ -0,0 +1,7 @@
+import { CSSProperties } from 'react';
+type FooterProps = {
+    children: any;
+    style?: CSSProperties;
+};
+export declare function Footer({ children, style }: FooterProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/Table/Header.d.ts

@@ -0,0 +1,7 @@
+import { CSSProperties } from 'react';
+type HeaderProps = {
+    children: any;
+    style?: CSSProperties;
+};
+export declare function Header({ children, style }: HeaderProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/Table/Overhead.d.ts

@@ -0,0 +1,7 @@
+import { CSSProperties } from 'react';
+type OverheadProps = {
+    children: any;
+    style?: CSSProperties;
+};
+export declare function Overhead({ children, style }: OverheadProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/Table/Row.d.ts

@@ -0,0 +1,12 @@
+import { CSSProperties } from 'react';
+type RowProps = {
+    children: any;
+    onClick?: () => void;
+    selected?: boolean;
+    onDoubleClick?: () => void;
+    /** Row's height in pixels (defaults to 50px) */
+    rowHeight?: number;
+    style?: CSSProperties;
+};
+export declare function Row({ children, onClick, selected, onDoubleClick, rowHeight, style }: RowProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/Table/Status.d.ts

@@ -0,0 +1,8 @@
+import { CSSProperties } from 'react';
+type StatusProps = {
+    children: string;
+    color: 'blue' | 'green' | 'red' | 'yellow' | 'magenta' | 'greenBlue' | 'strongRed' | 'strongYellow' | 'darkBlue' | 'grayBlue' | 'darkGreen' | 'darkPink' | 'lightPurple' | 'darkPurple' | 'darkRed' | 'orange' | 'strongBlue';
+    style?: CSSProperties;
+};
+export declare function Status({ children, color, style }: StatusProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/Table/Table.d.ts

@@ -0,0 +1,10 @@
+import { CSSProperties } from 'react';
+type TableProps = {
+    children: any;
+    id?: string;
+    theme?: 'dark' | 'light';
+    size?: 'small' | 'normal';
+    style?: CSSProperties;
+};
+export declare function Table({ children, id, theme, size, style }: TableProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/Transcript/ClassRecord.d.ts

@@ -0,0 +1,7 @@
+import { TranscriptCreditRow } from './Transcript';
+type ClassRecordProps = {
+    studentProgress: TranscriptCreditRow[];
+    snapshot?: boolean;
+};
+export default function ClassRecord({ studentProgress, snapshot }: ClassRecordProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/Transcript/GradingAndCreditSystem.d.ts

@@ -0,0 +1,7 @@
+import { TranscriptData } from './Transcript';
+type GradingAndCreditSystemProps = {
+    snapshot: TranscriptData['snapshot'];
+    total: TranscriptData['total'];
+};
+export default function GradingAndCreditSystem({ snapshot, total }: GradingAndCreditSystemProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/Transcript/Header.d.ts

@@ -0,0 +1,5 @@
+type HeaderProps = {
+    title: string;
+};
+export default function Header({ title }: HeaderProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/Transcript/StudentInformation.d.ts

@@ -0,0 +1,6 @@
+import { TranscriptData } from './Transcript';
+type StudentInformationProps = {
+    student: TranscriptData['student'];
+};
+export default function StudentInformation({ student }: StudentInformationProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/Transcript/Transcript.d.ts

@@ -0,0 +1,69 @@
+export type TranscriptCreditRow = {
+    subject_name: string | null;
+    base_course_name: string | null;
+    fk_id_credit_status_type: number | null;
+    credit_status_type_name: string | null;
+    credits: number | null;
+    grade: string | null;
+    gpa: number | null;
+    wgpa: number | null;
+    fk_id_term: number | null;
+    term_name: string;
+    fk_id_credit_type: number | null;
+    credit_type_name: string | null;
+    fk_id_course_type: number | null;
+    course_type_name: string | null;
+    in_progress: boolean;
+    course_type_tag?: string;
+    credit_type_tag?: string;
+    is_drop?: boolean;
+};
+export type TranscriptData = {
+    student: {
+        birthdate: string;
+        comments: string | null;
+        entrance_date: string;
+        first_name: string;
+        gender_name: string;
+        graduation_date: string | null;
+        guardian_name: string;
+        id: number;
+        last_name: string;
+        withdrawal_date: string | null;
+    };
+    credits: {
+        subject_name: string;
+        base_course_name: string;
+        fk_id_credit_status_type: number | null;
+        credit_status_type_name: string | null;
+        credits: number;
+        grade: string;
+        gpa: number;
+        wgpa: number;
+        fk_id_term: number;
+        term_name: string;
+        fk_id_credit_type: number;
+        credit_type_name: string | null;
+        fk_id_course_type: number | null;
+        course_type_name: string | null;
+        in_progress: boolean;
+        course_type_tag?: string;
+        credit_type_tag?: string;
+        is_drop?: boolean;
+    }[];
+    total: {
+        cumulative_gpa: number;
+        earned_credits: number;
+    };
+    snapshot: {
+        issue_date: string;
+        issued_by: string;
+    } | null;
+};
+type PartialTranscriptsProps = {
+    comments: string | null;
+    data: TranscriptData;
+    title: string;
+};
+export declare function Transcript({ data, title }: PartialTranscriptsProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/main.d.ts

@@ -0,0 +1,14 @@
+export { Accordion } from './Accordion/Accordion';
+export { DocumentRenderer } from './DocumentRenderer/DocumentRenderer';
+export { DocumentViewer } from './DocumentViewer/DocumentViewer';
+export { RightSidePanel } from './RightSidePanel/RightSidePanel';
+export { BodyContainer } from './Table/BodyContainer';
+export { Cell } from './Table/Cell';
+export { ExpansibleRow } from './Table/ExpansibleRow';
+export { Footer } from './Table/Footer';
+export { Header } from './Table/Header';
+export { Overhead } from './Table/Overhead';
+export { Row } from './Table/Row';
+export { Status } from './Table/Status';
+export { Table } from './Table/Table';
+export { Transcript } from './Transcript/Transcript';