@alaarab/ogrid-angular 2.0.2

package/dist/types/types/dataGridTypes.d.ts

@@ -0,0 +1,126 @@
+import type { TemplateRef } from '@angular/core';
+import type { IColumnDef, IColumnGroupDef, ICellValueChangedEvent } from './columnTypes';
+export type { RowId, UserLike, UserLikeInput, FilterValue, IFilters, IFetchParams, IPageResult, IDataSource, IGridColumnState, RowSelectionMode, IRowSelectionChangeEvent, StatusBarPanel, IStatusBarProps, IActiveCell, ISelectionRange, SideBarPanelId, ISideBarDef, IOGridApi, } from '@alaarab/ogrid-core';
+export { toUserLike, isInSelectionRange, normalizeSelectionRange } from '@alaarab/ogrid-core';
+import type { RowId, UserLike, IFilters, FilterValue, RowSelectionMode, IRowSelectionChangeEvent, IStatusBarProps, IDataSource, ISideBarDef } from '@alaarab/ogrid-core';
+/** Base props shared by both client-side and server-side OGrid modes. */
+interface IOGridBaseProps<T> {
+    columns: (IColumnDef<T> | IColumnGroupDef<T>)[];
+    getRowId: (item: T) => RowId;
+    page?: number;
+    pageSize?: number;
+    sort?: {
+        field: string;
+        direction: 'asc' | 'desc';
+    };
+    filters?: IFilters;
+    visibleColumns?: Set<string>;
+    isLoading?: boolean;
+    onPageChange?: (page: number) => void;
+    onPageSizeChange?: (size: number) => void;
+    onSortChange?: (sort: {
+        field: string;
+        direction: 'asc' | 'desc';
+    }) => void;
+    onFiltersChange?: (filters: IFilters) => void;
+    onVisibleColumnsChange?: (cols: Set<string>) => void;
+    columnOrder?: string[];
+    onColumnOrderChange?: (order: string[]) => void;
+    onColumnResized?: (columnId: string, width: number) => void;
+    onColumnPinned?: (columnId: string, pinned: 'left' | 'right' | null) => void;
+    freezeRows?: number;
+    freezeCols?: number;
+    editable?: boolean;
+    cellSelection?: boolean;
+    onCellValueChanged?: (event: ICellValueChangedEvent<T>) => void;
+    onUndo?: () => void;
+    onRedo?: () => void;
+    canUndo?: boolean;
+    canRedo?: boolean;
+    rowSelection?: RowSelectionMode;
+    selectedRows?: Set<RowId>;
+    onSelectionChange?: (event: IRowSelectionChangeEvent<T>) => void;
+    statusBar?: boolean | IStatusBarProps;
+    defaultPageSize?: number;
+    defaultSortBy?: string;
+    defaultSortDirection?: 'asc' | 'desc';
+    toolbar?: TemplateRef<unknown>;
+    toolbarBelow?: TemplateRef<unknown>;
+    emptyState?: {
+        message?: string;
+        render?: TemplateRef<unknown>;
+    };
+    entityLabelPlural?: string;
+    className?: string;
+    columnChooser?: boolean | 'toolbar' | 'sidebar';
+    layoutMode?: 'content' | 'fill';
+    suppressHorizontalScroll?: boolean;
+    sideBar?: boolean | ISideBarDef;
+    pageSizeOptions?: number[];
+    onFirstDataRendered?: () => void;
+    onError?: (error: unknown) => void;
+    onCellError?: (error: Error) => void;
+    'aria-label'?: string;
+    'aria-labelledby'?: string;
+}
+/** Client-side mode: pass a data array. */
+export interface IOGridClientProps<T> extends IOGridBaseProps<T> {
+    data: T[];
+    dataSource?: never;
+}
+/** Server-side mode: pass a dataSource. */
+export interface IOGridServerProps<T> extends IOGridBaseProps<T> {
+    data?: never;
+    dataSource: IDataSource<T>;
+}
+/** Props for the OGrid wrapper (shared across Angular UI packages).
+ *  Must provide either `data` (client-side) or `dataSource` (server-side), not both. */
+export type IOGridProps<T> = IOGridClientProps<T> | IOGridServerProps<T>;
+/** Props passed from OGridService to the framework-specific DataGridTable. */
+export interface IOGridDataGridProps<T> {
+    items: T[];
+    columns: (IColumnDef<T> | IColumnGroupDef<T>)[];
+    getRowId: (item: T) => RowId;
+    sortBy?: string;
+    sortDirection: 'asc' | 'desc';
+    onColumnSort: (columnKey: string) => void;
+    visibleColumns: Set<string>;
+    columnOrder?: string[];
+    onColumnOrderChange?: (order: string[]) => void;
+    onColumnResized?: (columnId: string, width: number) => void;
+    onColumnPinned?: (columnId: string, pinned: 'left' | 'right' | null) => void;
+    pinnedColumns?: Record<string, 'left' | 'right'>;
+    initialColumnWidths?: Record<string, number>;
+    freezeRows?: number;
+    freezeCols?: number;
+    layoutMode?: 'content' | 'fill';
+    suppressHorizontalScroll?: boolean;
+    isLoading?: boolean;
+    loadingMessage?: string;
+    editable?: boolean;
+    cellSelection?: boolean;
+    onCellValueChanged?: (event: ICellValueChangedEvent<T>) => void;
+    onUndo?: () => void;
+    onRedo?: () => void;
+    canUndo?: boolean;
+    canRedo?: boolean;
+    rowSelection?: RowSelectionMode;
+    selectedRows?: Set<RowId>;
+    onSelectionChange?: (event: IRowSelectionChangeEvent<T>) => void;
+    statusBar?: IStatusBarProps;
+    filters: IFilters;
+    onFilterChange: (key: string, value: FilterValue | undefined) => void;
+    filterOptions: Record<string, string[]>;
+    loadingFilterOptions: Record<string, boolean>;
+    peopleSearch?: (query: string) => Promise<UserLike[]>;
+    getUserByEmail?: (email: string) => Promise<UserLike | undefined>;
+    emptyState?: {
+        onClearAll: () => void;
+        hasActiveFilters: boolean;
+        message?: string;
+        render?: TemplateRef<unknown>;
+    };
+    onCellError?: (error: Error) => void;
+    'aria-label'?: string;
+    'aria-labelledby'?: string;
+}

package/dist/types/types/index.d.ts

@@ -0,0 +1,3 @@
+export type { ColumnFilterType, IColumnFilterDef, IColumnMeta, IColumnDef, IColumnGroupDef, IColumnDefinition, ICellValueChangedEvent, ICellEditorProps, CellEditorParams, IValueParserParams, IDateFilterValue, HeaderCell, HeaderRow, } from './columnTypes';
+export type { RowId, UserLike, UserLikeInput, FilterValue, IFilters, IFetchParams, IPageResult, IDataSource, IGridColumnState, IOGridApi, IOGridProps, IOGridClientProps, IOGridServerProps, IOGridDataGridProps, RowSelectionMode, IRowSelectionChangeEvent, StatusBarPanel, IStatusBarProps, IActiveCell, ISelectionRange, SideBarPanelId, ISideBarDef, } from './dataGridTypes';
+export { toUserLike, isInSelectionRange, normalizeSelectionRange } from './dataGridTypes';

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@alaarab/ogrid-angular",
+  "version": "2.0.2",
+  "description": "OGrid Angular – Angular services, signals, and headless components for OGrid data grids.",
+  "main": "dist/esm/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/esm/index.js"
+    }
+  },
+  "scripts": {
+    "build": "rimraf dist && tsc -p tsconfig.build.json",
+    "test": "jest --passWithNoTests"
+  },
+  "keywords": ["ogrid", "angular", "datatable", "typescript", "grid", "signals"],
+  "author": "Ala Arab",
+  "license": "MIT",
+  "files": ["dist", "README.md", "LICENSE"],
+  "engines": { "node": ">=18" },
+  "dependencies": {
+    "@alaarab/ogrid-core": "2.0.2"
+  },
+  "peerDependencies": {
+    "@angular/core": "^21.0.0",
+    "@angular/common": "^21.0.0"
+  },
+  "devDependencies": {
+    "@angular/core": "^21.1.4",
+    "@angular/common": "^21.1.4",
+    "@angular/compiler": "^21.1.4",
+    "@angular/platform-browser": "^21.1.4",
+    "@angular/platform-browser-dynamic": "^21.1.4",
+    "rxjs": "^7.8.0",
+    "zone.js": "^0.15.0",
+    "typescript": "^5.7.3"
+  },
+  "publishConfig": { "access": "public" }
+}