@gridstorm/angular 0.1.2

package/src/gridstorm.service.ts

@@ -0,0 +1,101 @@
+// ─── GridStorm Service ───
+// Injectable service for managing multiple GridStorm instances.
+// Allows Angular components to access grid APIs by a unique identifier,
+// useful in applications with multiple grids or cross-component communication.
+
+import { Injectable } from '@angular/core';
+import type { GridApi } from '@gridstorm/core';
+
+/**
+ * Service for registering and retrieving GridStorm API instances.
+ *
+ * Use this service when you have multiple grids in your application
+ * and need to access their APIs from different components or services.
+ *
+ * @example
+ * ```typescript
+ * // In a component that hosts the grid:
+ * constructor(private gridService: GridStormService) {}
+ *
+ * onGridReady(api: GridApi) {
+ *   this.gridService.registerApi('employees', api);
+ * }
+ *
+ * // In another component that needs to interact with the grid:
+ * constructor(private gridService: GridStormService) {}
+ *
+ * exportData() {
+ *   const api = this.gridService.getApi('employees');
+ *   if (api) {
+ *     const rows = api.getSelectedRows();
+ *     // ... do something with rows
+ *   }
+ * }
+ * ```
+ */
+@Injectable({ providedIn: 'root' })
+export class GridStormService {
+  private apiMap = new Map<string, GridApi>();
+
+  /**
+   * Registers a GridApi instance under a unique identifier.
+   *
+   * Call this from the `(gridReady)` output handler of the `<gridstorm>` component.
+   * If an API with the same ID already exists, it will be replaced.
+   *
+   * @param id - A unique string identifier for this grid instance.
+   * @param api - The GridApi instance to register.
+   */
+  registerApi(id: string, api: GridApi): void {
+    this.apiMap.set(id, api);
+  }
+
+  /**
+   * Retrieves a previously registered GridApi by its identifier.
+   *
+   * @param id - The unique identifier used during registration.
+   * @returns The GridApi instance, or `undefined` if not found.
+   */
+  getApi(id: string): GridApi | undefined {
+    return this.apiMap.get(id);
+  }
+
+  /**
+   * Removes a registered GridApi by its identifier.
+   *
+   * Call this when a grid component is destroyed to prevent memory leaks.
+   *
+   * @param id - The unique identifier of the API to remove.
+   */
+  removeApi(id: string): void {
+    this.apiMap.delete(id);
+  }
+
+  /**
+   * Returns all registered grid API identifiers.
+   *
+   * @returns An array of registered grid IDs.
+   */
+  getRegisteredIds(): string[] {
+    return Array.from(this.apiMap.keys());
+  }
+
+  /**
+   * Checks whether a grid API is registered under the given identifier.
+   *
+   * @param id - The unique identifier to check.
+   * @returns `true` if an API is registered with that ID.
+   */
+  hasApi(id: string): boolean {
+    return this.apiMap.has(id);
+  }
+
+  /**
+   * Removes all registered grid APIs.
+   *
+   * Useful during application teardown or testing.
+   */
+  clear(): void {
+    this.apiMap.clear();
+  }
+}

package/src/index.ts

@@ -0,0 +1,23 @@
+// ─── @gridstorm/angular — Public API ───
+
+// Component
+export { GridStormComponent } from './gridstorm.component';
+
+// Service
+export { GridStormService } from './gridstorm.service';
+
+// Types
+export type {
+  GridStormInputs,
+  GridStormOutputs,
+  GridRegistration,
+} from './types';
+
+// Re-export commonly needed core types for convenience
+export type {
+  GridApi,
+  GridConfig,
+  GridEngine,
+  ColumnDef,
+  GridPlugin,
+} from '@gridstorm/core';

package/src/types.ts

@@ -0,0 +1,94 @@
+// ─── Angular-Specific Types for GridStorm ───
+
+import type { GridApi, GridConfig, ColumnDef, GridPlugin } from '@gridstorm/core';
+
+/**
+ * Input configuration for the GridStorm Angular component.
+ *
+ * Maps GridConfig properties to Angular `@Input()` bindings.
+ * All properties are optional and match the core GridConfig interface.
+ *
+ * @typeParam TData - The type of each row data object.
+ */
+export interface GridStormInputs<TData = any> {
+  /** Column definitions describing each column's structure and behavior. */
+  columns: ColumnDef<TData>[];
+
+  /** Client-side row data array. */
+  rowData: TData[];
+
+  /** Array of plugins to install during grid initialization. */
+  plugins: GridPlugin<TData>[];
+
+  /** Callback to generate a unique string ID for each row. */
+  getRowId?: GridConfig<TData>['getRowId'];
+
+  /** Height of each data row in pixels. */
+  rowHeight: number;
+
+  /** Theme identifier: 'light', 'dark', or custom theme name. */
+  theme: string;
+
+  /** Density mode: 'compact', 'normal', or 'comfortable'. */
+  density: string;
+
+  /** Default column definition applied to all columns as fallback. */
+  defaultColDef?: Partial<ColumnDef<TData>>;
+
+  /** Number of rows per page when pagination is enabled. */
+  paginationPageSize?: number;
+
+  /** Height of the header row in pixels. */
+  headerHeight?: number;
+
+  /** Controls how the grid's DOM height is determined. */
+  domLayout?: GridConfig<TData>['domLayout'];
+
+  /** Row selection mode: 'single', 'multiple', or false. */
+  rowSelection?: GridConfig<TData>['rowSelection'];
+
+  /** When true, enables client-side pagination. */
+  pagination?: boolean;
+
+  /** ARIA label for the grid root element. */
+  ariaLabel?: string;
+}
+
+/**
+ * Event payloads emitted by the GridStorm Angular component.
+ *
+ * These are emitted through Angular `@Output()` EventEmitter bindings,
+ * bridging core engine events to Angular's event system.
+ *
+ * @typeParam TData - The type of each row data object.
+ */
+export interface GridStormOutputs<TData = any> {
+  /** Emitted when the grid engine is fully initialized and the API is ready. */
+  gridReady: GridApi<TData>;
+
+  /** Emitted when row data changes. */
+  rowDataChanged: { rowData: TData[] };
+
+  /** Emitted when the selection state changes. */
+  selectionChanged: { selectedNodes: any[]; source: string };
+
+  /** Emitted when the sort model changes. */
+  sortChanged: { sortModel: any[] };
+
+  /** Emitted when the filter model changes. */
+  filterChanged: { filterModel: Record<string, any> };
+
+  /** Emitted when a cell value is changed through editing. */
+  cellValueChanged: { node: any; colId: string; oldValue: any; newValue: any };
+}
+
+/**
+ * Options for the GridStormService `registerApi` call.
+ */
+export interface GridRegistration {
+  /** Unique identifier for this grid instance. */
+  id: string;
+
+  /** The grid API instance. */
+  api: GridApi;
+}