@bexis2/bexis2-core-ui/src/lib/models/Models.ts

Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).

import type { SvelteComponent } from 'svelte';
import type { ColumnFilterFn } from 'svelte-headless-table/lib/plugins';
import type { Writable } from 'svelte/store';

import type {
	FilterOptionsEnum,
	decimalCharacterType,
	notificationType,
	orientationType,
	textMarkerType,
	textSeperatorType
} from './Enums';

// page
export interface linkType {
	label: string;
	url: string;
}

// Form
export interface inputType {
	id: string;
	label: string;
	feedback: string[];
	invalid: boolean;
	valid: boolean;
	required: boolean;
	placeholder: string;
}

export interface fileInfoType {
	name: string;
	type: string;
	length: number;
	description: string;
	validationHash: string;
}

export interface fileUploaderType {
	accept: string[];
	existingFiles: fileInfoType[];
	descriptionType: number;
	multiple: boolean;
	maxSize: number;
}

export interface asciiFileReaderInfoType extends fileReaderInfoType {
	cells: boolean[];
	seperator: textSeperatorType;
	textMarker: textMarkerType;
}

export interface fileReaderInfoType {
	decimal: decimalCharacterType;
	orientation: orientationType;
	offset: number;
	variables: number;
	data: number;
	unit: number;
	description: number;
	dateformat: string;
}

export interface filesType {
	accepted: Blob[];
	rejected: Blob[];
}

export type userType = {
	name: string;
};

export interface fileObjType {
	path: string;
	lastModified: number;
	lastModifiedDate: Date;
	name: string;
	size: number;
	type: string;
	webkitRelativePath: string;
}

export interface ColumnInstructions {
	toStringFn?: (any) => string; // value by default
	toSortableValueFn?: (any) => string | number; // value by default
	toFilterableValueFn?: (any) => string | number | Date; // value by default
	renderComponent?: typeof SvelteComponent; // null by default
}

// Table column type
export interface Column {
	header?: string; // key by default
	exclude?: boolean; // false by default
	instructions?: ColumnInstructions;
	disableFiltering?: boolean; // false by default
	disableSorting?: boolean; // false by default
	colFilterFn?: ColumnFilterFn;
	colFilterComponent?: typeof SvelteComponent;
	minWidth?: number; // auto by default
	fixedWidth?: number; // auto by default
}

export interface Columns {
	[key: string]: Column;
}

// Server config type for the table
export type ServerConfig = {
	baseUrl?: string; // Base URL for server-side table
	sendModel?: Send; // Send model for server-side table
	entityId?: number; // Entity ID for server-side table
	versionId?: number; // Version ID for server-side table
};

// Table config type
export interface TableConfig<T> {
	id: string;
	data: Writable<T[]>;
	resizable?: 'none' | 'rows' | 'columns' | 'both'; // none by default
	showColumnsMenu?: boolean; // false by default
	toggle?: boolean; // false by default
	search?: boolean; // true by default
	fitToScreen?: boolean; // true by default
	height?: null | number; // null by default
	rowHeight?: number; // auto by default
	columns?: Columns;
	exportable?: boolean; // false by default
	pageSizes?: number[]; // [5, 10, 20, 50, 100] by default
	defaultPageSize?: number; // 10 by default
	optionsComponent?: typeof SvelteComponent;

	server?: ServerConfig;
}

// lists
export interface keyValuePairType {
	id: number;
	text: string;
}

export interface listItemType {
	id: number;
	text: string;
	group: string;
	description: string;
}

//help
export interface helpItemType {
	id?: string;
	name: string;
	description: string;
	link?: string;
}

export interface helpStoreType {
	itemId?: string;
	helpItems: helpItemType[];
}

// notifications (toasts)
export interface notificationItemType {
	notificationType?: notificationType;
	message: string;
}

export interface notificationStoreType {
	notificationType: notificationType;
	message: string;
	btnStyle: string;
}

// Table column type for server-side table
export type ServerColumn = {
	column: string; // column name on client side
	key: string; // column name received from the server
	exclude?: boolean; // false by default
	instructions?: {
		missingValues?: { [key: string | number]: string };
		displayPattern?: string;
	};
};

export type OrderBy = {
	column: string;
	direction: 'asc' | 'desc';
};

export type Filter = {
	column: string;
	filterBy: FilterOptionsEnum;
	value: string | number | Date | boolean;
};

export interface FacetOption {
	name: string;
	displayName: string;
	count?: number;
	selected?: boolean;
}

export interface FacetGroup {
	name: string;
	displayName: string;
	selected?: boolean;
	children: FacetOption[];
	count?: number;
}

export interface SelectedFacetGroup extends Omit<FacetGroup, 'children'> {
	children: {
		[key: string]: FacetOption;
	};
}

export class Send {
	id: number;
	limit: number;
	offset: number;
	q: string;
	version?: number;
	filter: Filter[];
	order: OrderBy[];

	constructor() {
		this.id = 0;
		this.limit = 10;
		this.offset = 0;
		this.version = 0;
		this.q = '';
		this.filter = [];
		this.order = [];
	}
}

export class Receive {
	count: number;
	data: any[];
	send: Send;
	columns?: ServerColumn[];

	constructor() {
		this.count = 0;
		this.data = [];
		this.send = new Send();
		this.columns = [];
	}
}

export class errorType {
	statusText: string;
	status: number;
	error: string;
	stackTrace: string;

	constructor() {
		this.statusText = '';
		this.status = 0;
		this.error = '';
		this.stackTrace = '';
	}
}