@open-dcp/grid 0.0.1 → 0.2.17

package/.github/workflows/main.yml

@@ -0,0 +1,42 @@
+name: Publish to npm
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+  id-token: write # Required to mint the OIDC token
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build package
+        run: npm run build --if-present
+
+      # Step 2: Switch to Node 22+ to provide an npm version that supports Trusted Publishing OIDC
+      - name: Setup Node.js (Publish Environment)
+        uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Publish to npm
+        run: |
+          # Remove any static auth token line injected by setup-node into .npmrc
+          sed -i '/_authToken/d' /home/runner/work/_temp/.npmrc 2>/dev/null || true
+          npm publish --provenance --access public

package/CLA.md

@@ -0,0 +1,22 @@
+## Individual Contributor License Agreement
+
+Thank you for your interest in contributing to this open source software project (“Project”) made available 
+by under the terms defined in `LICENSE`. This Individual Contributor License Agreement (“Agreement”) sets 
+out the terms governing any source code, object code, bug fixes, configuration changes, tools, 
+specifications, documentation, data, materials, feedback, information or other works of 
+authorship that you submit or have submitted, in any form and in any manner, to the Project (collectively “Contributions”). 
+
+Third Party Content/Rights. If your Contribution includes or is based on any source code, object code, bug fixes, configuration changes, tools, 
+specifications, documentation, data, materials, feedback, information or other works of authorship 
+that were not authored by you (“Third Party Content”) or if you are aware of any third party intellectual 
+property or proprietary rights associated with your Contribution (“Third Party Rights”), 
+then you agree to include with the submission of your Contribution full details respecting 
+such Third Party Content and Third Party Rights, including, without limitation, identification of 
+which aspects of your Contribution contain Third Party Content or are associated with Third Party Rights, 
+the owner/author of the Third Party Content and Third Party Rights, where you obtained the Third Party Content, 
+and any applicable third party license terms or restrictions respecting the Third Party Content and Third Party Rights. 
+For greater certainty, the foregoing obligations respecting the identification of Third Party Content and Third Party Rights 
+do not apply to any portion of a Project that is incorporated into your Contribution to that same Project.
+
+No Obligation. You acknowledge that the Project is under no obligation to use or incorporate your Contributions into any of the Projects. 
+The decision to use or incorporate your Contributions into any of the Projects will be made at the sole discretion of Projects authorized delegates.

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024 F. Hoffmann-La Roche Ltd
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE.md

@@ -0,0 +1,31 @@
+# NOTICE
+
+This project is licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at:
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+## Additional Terms:
+
+This project includes branding specific to F. Hoffmann-La Roche Ltd ("Roche").
+When redistributing or using this project, you must use the provided customizer tool
+to remove Roche-specific branding elements that pertain solely to the appearance
+of the frontend user interface. These branding elements may include logos, colors,
+fonts, and other visual aspects associated with Roche's identity.
+
+The customizer tool does not alter any functional aspects of the project and is intended
+only to modify visual elements to ensure compliance with Roche's branding policies.
+The customizer tool can be found at:
+
+    https://gitlab.com/roche/dcp/platform/frontend/customizer
+
+By using this project, you agree to apply the customizer tool to remove Roche-specific
+branding elements before distribution or use in a production environment.
+
+This requirement does not alter the terms of the Apache License 2.0, but adds an
+additional condition for the use and redistribution of this project in its branded form.
+
+---
+
+F. Hoffmann-La Roche Ltd

package/README.md

@@ -1,39 +1,39 @@
-<a href="https://open-dcp.ai" target="_blank"><img src="https://docs.open-dcp.ai/assets/img/logo.png" width="400" alt="Laravel Logo"></a>
-
-##### Pioneering open-source GMP analytics for a more accessible, enjoyable, and productive data-driven future.
-
-<a href="https://open-dcp.ai"><img src="https://img.shields.io/badge/license-Apache--2.0-blue.svg" alt="License Apache-2.0"></a> <a href="https://www.repostatus.org/#wip"><img src="https://www.repostatus.org/badges/latest/wip.svg" alt="Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public."></a>
-
-## About Data Computation Platform (DCP)
-
-The [Data Computation Platform (DCP)](https://open-dcp.ai) is a browser-based application enabling various data analytics and visualization concepts for (real-time) process monitoring and reporting. It serves as the nexus between innovation and compliance in pharmaceuticals, enabling seamless integration of tools for GxP-compliant advancements. Validated for GxP compliance, DCP facilitates both the parallel usage of apps in a regulated context and as engineering or information-only tools. Evolving from a closed system to an open, collaborative platform, DCP embodies resilience, overcoming challenges to drive collective progress. Ultimately, DCP signifies the union of innovation and compliance in Pharma 4.0, propelling unified advancements while steadfastly meeting regulatory standards.
-
-### Repository Structure
-
-DCP delivers its dedicated data analytics and visualization concepts as modules extending the DCP Framework. These modules seamlessly integrate with the framework and foster synergies to reduce development and maintenance costs while increasing delivery speed.
-
-#### DCP Framework
-
-#### DCP Modules
-
-#### DCP Packages
-
-
-## Learning DCP
-
-A very simple [Get Started](https://open-dcp.ai/get-started) guide is available on our website. To delve deeper into the application, please refer to the documentation provided on [docs.open-dcp.ai](https://docs.open-dcp.ai).
-
-## Security
-
-If you think you have found a security vulnerability in DCP or one of its modules, you can report it using our [Contact Form](https://open-dcp.ai/contact) or by emailing us at [info@open-dcp.ai](mailto:info@open-dcp.ai). All security vulnerabilities will be promptly addressed.
-
-## Contributing
-
-The contribution guide can be found in the [DCP documentation](https://docs.open-dcp.ai/contribution_guide/1.0/code_of_conduct).
-
-## License
-
-DCP and its modules are open-source and licensed under the [Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt).
-
-### Notice
-This project includes branding specific to Roche. When redistributing or using this project, you must use the provided customizer tool to remove Roche-specific branding elements that pertain solely to the appearance of the frontend user interface.
+<a href="https://open-dcp.ai" target="_blank"><img src="https://docs.open-dcp.ai/assets/img/logo.png" width="400" alt="Open-DCP Logo"></a>
+
+##### Pioneering open-source GMP analytics for a more accessible, enjoyable, and productive data-driven future.
+
+<a href="https://open-dcp.ai"><img src="https://img.shields.io/badge/license-Apache--2.0-blue.svg" alt="License Apache-2.0"></a> <a href="https://docs.open-dcp.ai"><img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fopen-dcp.ai%2Frepo-status.json" alt="Project Status"></a>
+
+## About Data Computation Platform (DCP)
+
+The [Data Computation Platform (DCP)](https://open-dcp.ai) is a browser-based application enabling various data analytics and visualization concepts for (real-time) process monitoring and reporting. It serves as the nexus between innovation and compliance in pharmaceuticals, enabling seamless integration of tools for GxP-compliant advancements. Validated for GxP compliance, DCP facilitates both the parallel usage of apps in a regulated context and as engineering or information-only tools. Evolving from a closed system to an open, collaborative platform, DCP embodies resilience, overcoming challenges to drive collective progress. Ultimately, DCP signifies the union of innovation and compliance in Pharma 4.0, propelling unified advancements while steadfastly meeting regulatory standards.
+
+DCP delivers its dedicated data analytics and visualization concepts as modules extending the DCP Framework. These modules seamlessly integrate with the framework and foster synergies to reduce development and maintenance costs while increasing delivery speed.
+
+## Ecosystem & Packages
+
+DCP modules and client libraries are published across official package registries:
+
+* **GitHub:** [https://github.com/orgs/Roche/repositories?q=dcp-](https://github.com/orgs/Roche/repositories?q=dcp-)
+* **npm:** [@open-dcp](https://www.npmjs.com/org/open-dcp)
+* **Packagist:** [open-dcp](https://packagist.org/packages/open-dcp/)
+* **NuGet:** [OpenDCP](https://www.nuget.org/packages?q=OpenDCP)
+* **Documentation & Guides:** [docs.open-dcp.ai](https://docs.open-dcp.ai)
+
+*Upcoming Registries:* CRAN (R), Container Images
+
+## Learning DCP
+
+A very simple [Get Started](https://open-dcp.ai/get-started) guide is available on our website. To delve deeper into the application, please refer to the documentation provided on [docs.open-dcp.ai](https://docs.open-dcp.ai).
+
+## Security
+
+If you think you have found a security vulnerability in DCP or one of its modules, you can report it using our [Contact Form](https://open-dcp.ai/contact) or by emailing us at [info@open-dcp.ai](mailto:info@open-dcp.ai). All security vulnerabilities will be promptly addressed.
+
+## Contributing
+
+The contribution guide can be found in the [DCP documentation](https://docs.open-dcp.ai).
+
+## License
+
+DCP and its modules are open-source and licensed under the [Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt).

package/SECURITY.md

@@ -0,0 +1,27 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+At open-dcp.ai, we take security vulnerabilities seriously. If you discover a security issue within our project, please let us know immediately by using our [Contact Form](https://open-dcp.ai/contact) or by emailing us at [global.dcp-support@roche.com](mailto:global.dcp-support@roche.com). We appreciate your responsible disclosure.
+
+Our team will investigate and respond to your report promptly. We will also keep you informed of our progress in addressing the issue and coordinating the release of fixes.
+
+## Responsible Disclosure
+
+We encourage responsible disclosure of security vulnerabilities. We ask that you:
+
+- Do not disclose the vulnerability publicly until we have had sufficient time to address it.
+- Do not exploit the vulnerability for any malicious purpose.
+- Provide us with reasonable time to fix the issue before disclosing it to others.
+
+We are committed to working with security researchers and contributors to verify, address, and resolve reported vulnerabilities in a timely manner.
+
+## Security Releases
+
+Upon identifying and addressing a security vulnerability, we will release a new version of our project containing the necessary fixes. We will provide details about the vulnerability and the fixes included in the release notes.
+
+## Preferred Languages
+
+We prefer all communications to be in English.
+
+Thank you for helping us keep our project secure!

package/dist/GridService.d.ts

@@ -0,0 +1,83 @@
+import { BehaviorSubject, Observable } from 'rxjs';
+import { GridState, Column, Row, RenderRow, DisplayFormat, GridOptions, FilterSortUpdatePayload, GlobalSearchOptions, GlobalSearchState } from './types/grid';
+import { FilterNode } from '@open-dcp/filter';
+import { SortingCondition, ApiModeConfig } from './types/sorting';
+export declare class GridService {
+    readonly elementHeight: number;
+    readonly gridOptions: Partial<GridOptions>;
+    private readonly rowsSubject;
+    private readonly columnsSubject;
+    private readonly stateSubject;
+    displayFormatSubject: BehaviorSubject<DisplayFormat>;
+    displayFormat$: Observable<DisplayFormat>;
+    rows$: Observable<Row[]>;
+    rowCount$: Observable<number>;
+    columns$: Observable<Column[]>;
+    private container;
+    startIndex: number;
+    private firstRowHeight;
+    private lastRowHeight;
+    private apiMode;
+    private clientSideSort;
+    private clientSideFilter;
+    private readonly rowHeightService;
+    private readonly sortingService;
+    private readonly formattingService;
+    private readonly filteringService;
+    private readonly selectionService;
+    private filterSortSubject;
+    filterSort$: Observable<FilterSortUpdatePayload>;
+    private indexMapping;
+    constructor(rows: Row[], columns: Column[], gridOptions?: Partial<GridOptions>, sorts?: SortingCondition[], filterTree?: FilterNode | null, selections?: Set<number>);
+    private notifyFilterSortUpdate;
+    enableApiMode(config?: ApiModeConfig): void;
+    disableApiMode(): void;
+    shouldApplyClientSideFiltering(): boolean;
+    setRowsFromApi(rows: Row[]): void;
+    clearIndexMap(): void;
+    setIndexMapping(newMap: Map<number, number>): void;
+    setIndexMappingValue(newIndex: number, originalIndex: number): void;
+    getOriginalIndex(index: number): number;
+    getIndexMapping(): Map<number, number>;
+    updateDisplayFormat(newFormat: Partial<DisplayFormat>): void;
+    attachContainer(container: HTMLElement): void;
+    getContainer(): HTMLElement | null;
+    setStateValue(key: string, newValue: any): void;
+    getState(): Observable<GridState>;
+    getFirstRowHeight(): number;
+    getLastRowHeight(): number;
+    getRenderRows(): RenderRow[];
+    getRows(): Row[];
+    getCellDisplayValue(row: Row, columnKey: string | number): string;
+    getFilteredRows(): Row[];
+    getFilteredAndSortRows(): Row[];
+    rowCount(): number;
+    setRows(rows: Row[], shouldFormat?: boolean): void;
+    getColumns(): Column[];
+    setColumns(columns: Column[]): void;
+    getSortCondition(columnKey: string | number): SortingCondition | null;
+    toggleSort(columnKey: string | number): void;
+    addFilter(filterNode: FilterNode): void;
+    reset(): void;
+    resetFilter(columnKey: string | number): void;
+    setGlobalSearch(query: string, options?: GlobalSearchOptions): void;
+    clearGlobalSearch(): void;
+    getGlobalSearch(): GlobalSearchState | null;
+    getFilterIndexes(): number[] | null;
+    hasFilter(columnKey: string | number): boolean;
+    getSelected(): Observable<Set<number>>;
+    selectRow(index: number): void;
+    deselectRow(index: number): void;
+    toggleRowSelection(index: number): void;
+    selectAll(): void;
+    shiftSelect(startIndex: number, endIndex: number): void;
+    isSelected(index: number): boolean;
+    deselectAll(): void;
+    clearSelection(): void;
+    private getDisplayValue;
+    private getRowsOfInterest;
+    private rebuildIndexMapping;
+    updateRenderedRows(): void;
+    handleScroll(event: Event): void;
+    getScrollHeight(): number | undefined;
+}