@evenicanpm/portal-types-schemas 1.5.0 → 1.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@evenicanpm/portal-types-schemas",
-	"version": "1.5.0",
+	"version": "1.6.0",
 	"description": "",
 	"license": "ISC",
 	"author": "",
@@ -15,7 +15,8 @@
 		".": "./src/index.ts"
 	},
 	"files": [
-		"dist"
+		"dist",
+		"src"
 	],
 	"types": "./dist/index.d.ts",
 	"devDependencies": {
@@ -27,5 +28,5 @@
 		"typescript": "^5.6.3"
 	},
 	"dependencies": {},
-	"gitHead": "5c5e3fe19b92a17cbaf897b4cee20ee59331603f"
+	"gitHead": "9b18fe6294cc0e57332ec8703825a609ac7b73b2"
 }

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./table-param";
+export * from "./view-config";

package/src/table-param.ts

@@ -0,0 +1,51 @@
+import { z } from "zod";
+
+export const TableViewParamsSchema = z.object({
+	pageSize: z.number().default(5),
+	page: z.number().default(0),
+	filters: z.record(z.string(), z.unknown()).optional(),
+	searchTerm: z.string().optional().default(""),
+	searchColumn: z.string().default("all"),
+});
+
+// Extract the TypeScript interface from the schema
+export type TableViewParams = z.infer<typeof TableViewParamsSchema>;
+
+/**
+ * convert the table state into url params.
+ * @param params Filters and params stored from table state
+ * @returns Url params.
+ */
+export const tableStateToQuery = (params: TableViewParams): URLSearchParams => {
+	const { page, pageSize, searchTerm, searchColumn, filters } = params;
+	const searchParams = new URLSearchParams();
+	searchParams.set("page", String(page));
+	searchParams.set("pageSize", String(pageSize));
+
+	if (searchTerm && searchColumn) {
+		searchParams.set("searchTerm", searchTerm);
+		searchParams.set("searchColumn", searchColumn);
+	}
+
+	if (filters) searchParams.set("filters", JSON.stringify(filters));
+	return searchParams;
+};
+
+/**
+ * Pre-processes url params into portal format to be
+ * inserted into one of the DMS URL builders
+ *
+ * @param searchParams url params from next endpoint
+ * @returns table view params formatted filters/pagination
+ */
+export const queryToTableState = (
+	searchParams: URLSearchParams,
+): TableViewParams => {
+	const page = Number(searchParams.get("page") ?? 0);
+	const pageSize = Number(searchParams.get("pageSize") ?? 5);
+	const searchTerm = searchParams.get("searchTerm") ?? "";
+	const searchColumn = searchParams.get("searchColumn") ?? "";
+	const filtersValue = searchParams.get("filters");
+	const filters = filtersValue && JSON.parse(filtersValue);
+	return { page, pageSize, searchColumn, searchTerm, filters };
+};

package/src/view-config.ts

@@ -0,0 +1,113 @@
+import { z } from "zod";
+/**
+ * ColumnDataType
+ */
+export const ColumnDataTypeSchema = z.enum([
+	"String",
+	"int",
+	"numeric",
+	"date",
+	"datetime",
+	"url",
+]);
+export type ColumnDataType = z.infer<typeof ColumnDataTypeSchema>;
+
+/**
+ * DataMaskFormat
+ */
+export const DataMaskFormatSchema = z.enum([
+	"MM/DD/YYYY",
+	"MM-DD-YYYY",
+	"DD/MM/YYYY",
+	"DD-MM-YYYY",
+	"YYYY/MM/DD",
+	"YYYY-MM-DD HH:MI:SS",
+	"$0.00",
+	"0,00€",
+]);
+export type DataMaskFormat = z.infer<typeof DataMaskFormatSchema>;
+
+/**
+ * FilterOperation
+ */
+export const FilterOperationSchema = z.enum([
+	"eq",
+	"gt",
+	"lt",
+	"gte",
+	"lte",
+	"in",
+]);
+export type FilterOperation = z.infer<typeof FilterOperationSchema>;
+
+/**
+ * FilterOption
+ */
+export const FilterOptionSchema = z.object({
+	value: z.union([z.string(), z.number()]),
+	label: z.string(),
+});
+export type FilterOption = z.infer<typeof FilterOptionSchema>;
+
+/**
+ * FilterConfig
+ */
+export const FilterConfigSchema = z.object({
+	FilterOptions: z.array(FilterOptionSchema),
+	FilterType: z.string(),
+	FilterOperation: FilterOperationSchema,
+});
+export type FilterConfig = z.infer<typeof FilterConfigSchema>;
+
+/**
+ * Filter (from table metadata response)
+ */
+export const FilterSchema = z.object({
+	Operation: FilterOperationSchema,
+	Data: z.string(),
+	Value: z.union([z.string(), z.array(z.string()), z.number()]),
+});
+export type Filter = z.infer<typeof FilterSchema>;
+
+/**
+ * Column (recursive)
+ */
+export const ColumnSchema = z.object({
+	Label: z.string(),
+	Data: z.string(),
+	DataType: z.string(),
+	DataMask: z.string().optional(),
+	ColumnOrder: z.number().nullable().optional(),
+	IsSearchable: z.boolean().optional(),
+	IsFilterable: z.boolean().optional(),
+	Filters: z.array(FilterConfigSchema).optional(),
+	IsVisible: z.boolean().optional(),
+	IsSortable: z.boolean().optional(),
+	DisplayOrder: z.number().optional(),
+});
+
+export type Action = {
+	Name: string;
+	Type: string;
+	IdField?: string;
+};
+
+export interface Column {
+	Label: string;
+	Data: string;
+	DataType: string;
+	ColumnOrder: number | undefined | null;
+	DataMask?: string;
+	IsSearchable?: boolean;
+	IsFilterable?: boolean;
+	Filters?: FilterConfig[];
+	IsVisible?: boolean;
+	IsSortable?: boolean;
+	DisplayOrder?: number;
+	Children: Column[];
+}
+
+export type ViewConfig = {
+	Columns: Column[];
+	Actions?: Action[];
+};