@evenicanpm/portal-table-ui 1.4.0 → 1.5.0

package/src/features/table/logic/resolvers.ts

@@ -1,68 +0,0 @@
-import { method, multi } from "@arrows/multimethod";
-import type { Column } from "@evenicanpm/portal-types-schemas";
-import type * as Types from "../types";
-import type { FilterRequest } from "./types";
-
-/** MULTIMETHOD FOR FILTERS
- * Allows multiple implementations
- * based on multiple column properties.
- * Priotizes column name, but also can
- * use data type
- * @internal
- */
-export const resolveFilterUI = multi(
-	(req: FilterRequest, handlers: Types.Handlers.FilterRenderMap) => {
-		if (handlers?.[req.filterName]) return "BY_NAME";
-		if (handlers?.[req.filterType]) return "BY_TYPE";
-		return "NONE";
-	},
-	method(
-		"BY_NAME",
-		(req: FilterRequest, handlers: Types.Handlers.FilterRenderMap) =>
-			handlers[req.filterName],
-	),
-	method(
-		"BY_TYPE",
-		(req: FilterRequest, handlers: Types.Handlers.FilterRenderMap) =>
-			handlers[req.filterType],
-	),
-	method("NONE", () => () => null),
-);
-
-/**
- * Dispatch identifies which properties are
- * in handler, then provides corresponding method
- * @internal
- */
-export const resolveDataMask = multi(
-	(col: Column, handlers: Types.Handlers.DataMaskMap) => {
-		if (!col?.DataMask) return "SKIP";
-		if (handlers?.[col?.DataType]) return "BY_TYPE";
-		if (handlers?.[col?.Data]) return "BY_NAME";
-		return "SKIP";
-	},
-	method(
-		"BY_TYPE",
-		(col: Column, handlers: Types.Handlers.DataMaskMap) =>
-			handlers?.[col?.DataType],
-	),
-	method(
-		"BY_NAME",
-		(col: Column, handlers: Types.Handlers.DataMaskMap) =>
-			handlers?.[col?.Data],
-	),
-	method("SKIP", () => (value: string | number) => value),
-);
-
-/**
- * Simpler, doesn't need multimethod cause only dispatches on column name
- * @internal
- */
-export const resolveCellUI = (
-	col: Column,
-	handlers: Types.Handlers.CellRenderMap,
-) => {
-	if (Object.hasOwn(handlers, col.Data)) return handlers?.[col?.Data];
-
-	return (value: string | number) => value;
-};

package/src/features/table/logic/transformers.ts

@@ -1,56 +0,0 @@
-import type { Column } from "@evenicanpm/portal-types-schemas";
-
-/**
- * These are pure static functions that include business rules
- * and data manipulation to get the data into the correct
- * form for rendering.
- *
- * @packageDocumentation
- */
-
-/**
- * Gets filters and returns an array of the
- * active filters and corresponding options
- * in FilterRequest
- */
-export const getActiveFilters = (columns: Column[] | undefined) => {
-	return columns
-		?.filter((c) => c?.IsFilterable)
-		?.flatMap((c) =>
-			c?.Filters?.map((f) => ({
-				filterName: c.Data,
-				filterOptions: f.FilterOptions,
-				filterType: f.FilterType ?? c.DataType,
-			})),
-		);
-};
-
-/**
- * Filters and sorts visible cols
- */
-export const getVisibleColumns = (columns: Column[] | undefined) =>
-	columns
-		?.filter(
-			(column): column is Column & { ColumnOrder: number } =>
-				typeof column.ColumnOrder === "number",
-		)
-		.sort((a, b) => a.ColumnOrder - b.ColumnOrder);
-
-/**
- *
- */
-export const getVisibleDetails = (columns: Column[] | undefined) =>
-	columns
-		?.filter((col) => col.DisplayOrder)
-		?.sort((a, b) => {
-			if (a?.DisplayOrder && b?.DisplayOrder) {
-				return a?.DisplayOrder - b?.DisplayOrder;
-			}
-			return -1;
-		});
-
-/**
- * Filters and sorts visible cols
- */
-export const getSearchableColumns = (columns: Column[] | undefined) =>
-	columns?.filter((column) => column?.IsSearchable);

package/src/features/table/logic/types.ts

@@ -1,8 +0,0 @@
-/**
- * FILTER REQUEST to RESOLVER
- */
-export interface FilterRequest {
-	filterName: string;
-	filterOptions: string[];
-	filterType: string;
-}

package/src/features/table/types/schemas.ts

@@ -1,50 +0,0 @@
-import type { TableViewParams } from "@evenicanpm/portal-types-schemas";
-import type {
-	CellRenderMap,
-	DataMaskMap,
-	DetailsRenderMap,
-	FilterRenderMap,
-	NoResultsComponent,
-} from "./handlers";
-import type { TableRows } from "./queries";
-
-/**
- * These are primary domain models and the source of truth for table system.
- */
-
-/**
- * Status maps
- */
-export type StatusTextMap = Record<number | string, string>;
-
-export type StatusColor = "success" | "primary" | "warning" | "error";
-
-export type StatusColorMap = Record<number | string, StatusColor>;
-
-/**
- * Resource Definition
- */
-export interface Resource {
-	name: string;
-	label: string;
-	idField: string;
-
-	// Data Handlers
-	rowsQueryFn: (displaySettings: TableViewParams) => {
-		queryKey: readonly unknown[];
-		queryFn: () => Promise<TableRows>;
-	};
-
-	// UI Renderers & Mappings
-	cellRenderMap?: CellRenderMap;
-	dataMaskMap?: DataMaskMap;
-	filterRenderMap?: FilterRenderMap;
-	noResultsComponent?: NoResultsComponent;
-
-	// Optional Details view
-	detailsRenderMap?: DetailsRenderMap;
-
-	// State Visuals
-	statusTextMap: StatusTextMap;
-	statusColorMap: StatusColorMap;
-}

package/src/portal.tsx

@@ -1,68 +0,0 @@
-import { FlexBox } from "@evenicanpm/ui";
-import type { PropsWithChildren } from "react";
-import {
-	type AuthProviderProps,
-	PortalAuthProvider,
-} from "./auth/auth-context";
-import { TableDashboard } from "./features/table/components/dashboard/table-dashboard";
-
-/**
- * Main Entry point properties into portal package
- *
- *
- */
-interface PortalProps extends AuthProviderProps {
-	// Add Portal Specific Properties Here
-	// ie. roles
-}
-
-/**
- * The main **e4Portal** entry point.
- * * This is a React Functional Component that provides the core context
- * and layout for the application. It is required to wrap all components
- * that use the library's hooks or sub-components.
- *
- *
- * @param props - The properties passed to the Portal component.
- * @returns A React Element rendering the main application structure.
- */
-const Portal = ({
-	session,
-	logout,
-	children,
-}: PropsWithChildren<PortalProps>) => {
-	// Not Logged In
-	if (!session?.email) {
-		return (
-			<FlexBox mt={5} width="100%" justifyContent="center">
-				Please login to view the portal.
-			</FlexBox>
-		);
-	}
-
-	// Logged In yes
-	return (
-		<PortalAuthProvider session={session} logout={logout}>
-			{children}
-		</PortalAuthProvider>
-	);
-};
-
-/**
- *
- * # Feature: Table
- * This is the table feature component.
- * @params props
- *
- */
-Portal.Table = TableDashboard;
-
-/**
- *
- * # Feature: Settings
- * This is the table feature component.
- * @params props
- *
- */
-
-export { Portal, type PortalProps };

package/tsconfig.json

@@ -1,28 +0,0 @@
-{
-	"compilerOptions": {
-		"target": "ES6",
-		"useDefineForClassFields": true,
-		"lib": ["ES2022", "DOM", "DOM.Iterable"],
-		"module": "ESNext",
-		"sourceMap": true,
-		"esModuleInterop": true,
-		"skipLibCheck": true,
-		"declaration": true,
-		"preserveSymlinks": true,
-		"moduleResolution": "Node",
-		"resolveJsonModule": true,
-		"isolatedModules": true,
-		"emitDeclarationOnly": true,
-		"jsx": "preserve",
-		"strict": true,
-		"noUnusedLocals": true,
-		"noUnusedParameters": true,
-		"noFallthroughCasesInSwitch": true,
-		"allowJs": true,
-		"forceConsistentCasingInFileNames": true,
-		"incremental": true,
-		"baseUrl": "./",
-		"outDir": "./dist"
-	},
-	"include": ["src"]
-}

package/typedoc.json

@@ -1,10 +0,0 @@
-{
-	"highlightLanguages": [
-		"bash",
-		"typescript",
-		"tsx",
-		"javascript",
-		"html",
-		"css"
-	]
-}