diff --git a/packages/ts/react-grid/.eslintrc b/packages/ts/react-grid/.eslintrc new file mode 100644 index 0000000000..d445a4e4e1 --- /dev/null +++ b/packages/ts/react-grid/.eslintrc @@ -0,0 +1,5 @@ +{ + "parserOptions": { + "project": "./tsconfig.json" + } +} diff --git a/packages/ts/react-grid/.lintstagedrc.js b/packages/ts/react-grid/.lintstagedrc.js new file mode 100644 index 0000000000..4ea5625af3 --- /dev/null +++ b/packages/ts/react-grid/.lintstagedrc.js @@ -0,0 +1,6 @@ +import { commands } from '../../../.lintstagedrc.js'; + +export default { + 'src/**/*.{js,ts}': commands, + 'test/**/*.{js,ts}': commands, +}; diff --git a/packages/ts/react-grid/LICENSE b/packages/ts/react-grid/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/packages/ts/react-grid/LICENSE @@ -0,0 +1,201 @@ + 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 + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/packages/ts/react-grid/README.md b/packages/ts/react-grid/README.md new file mode 100644 index 0000000000..ad01975d54 --- /dev/null +++ b/packages/ts/react-grid/README.md @@ -0,0 +1,27 @@ +# Hilla React Grid + +[API documentation ↗](https://hilla.dev/docs/data-binding/reference) + +[![Latest Stable +Version](https://img.shields.io/npm/v/@hilla/react-grid.svg)](https://www.npmjs.com/package/@hilla/react-grid) + +A set of utilities for using grids with TypeScript and React. + +A part of the Hilla project. + +## Installation + +```bash +$ npm install @hilla/react-grid +``` + +## Contribution + +Read the [contributing guide](https://vaadin.com/docs/latest/contributing-docs/overview) to learn about our development process, how to propose bugfixes and improvements, and how to test your changes. + +## License + +Apache License 2.0 + +Vaadin collects development time usage statistics to improve this product. +For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics. diff --git a/packages/ts/react-grid/package.json b/packages/ts/react-grid/package.json new file mode 100644 index 0000000000..4f6d77de7b --- /dev/null +++ b/packages/ts/react-grid/package.json @@ -0,0 +1,65 @@ +{ + "name": "@hilla/react-grid", + "version": "2.2.0-beta1", + "description": "Hilla grid utils for React", + "main": "index.js", + "module": "index.js", + "type": "module", + "repository": { + "type": "git", + "url": "https://github.com/vaadin/hilla.git", + "directory": "packages/ts/react-grid" + }, + "keywords": [ + "Hilla", + "Grid", + "React" + ], + "scripts": { + "build": "tsc --isolatedModules -p tsconfig.build.json", + "lint": "echo \"Skipping\"", + "test": "karma start ../../../karma.config.cjs --port 9877", + "test:coverage": "echo \"Skipping\"", + "test:watch": "npm run test -- --watch", + "typecheck": "tsc --noEmit", + "version": "node ../../../scripts/bump/package-update.js" + }, + "exports": { + ".": { + "default": "./index.js" + } + }, + "author": "Vaadin Ltd", + "license": "Apache-2.0", + "bugs": { + "url": "https://github.com/vaadin/hilla/issues" + }, + "homepage": "https://hilla.dev", + "files": [ + "*.{d.ts.map,d.ts,js.map,js}" + ], + "publishConfig": { + "access": "public" + }, + "dependencies": { + "@types/react": "^18.2.20" + }, + "peerDependencies": { + "react": "^18" + }, + "devDependencies": { + "@esm-bundle/chai": "^4.3.4-fix.0", + "@testing-library/react": "^14.0.0", + "@testing-library/user-event": "^14.4.3", + "@types/chai": "^4.3.5", + "@types/chai-dom": "^1.11.0", + "@types/mocha": "^10.0.1", + "@types/sinon": "^10.0.16", + "@types/sinon-chai": "^3.2.9", + "@types/validator": "^13.11.1", + "chai-dom": "^1.11.0", + "sinon": "^15.2.0", + "sinon-chai": "^3.7.0", + "typescript": "^5.1.6" + } +} diff --git a/packages/ts/react-grid/src/autogrid.ts b/packages/ts/react-grid/src/autogrid.ts new file mode 100644 index 0000000000..397fcb7c44 --- /dev/null +++ b/packages/ts/react-grid/src/autogrid.ts @@ -0,0 +1,3 @@ +export const useAutoGrid = () => { + return 'foo'; +}; diff --git a/packages/ts/react-grid/src/index.ts b/packages/ts/react-grid/src/index.ts new file mode 100644 index 0000000000..99857ef0f1 --- /dev/null +++ b/packages/ts/react-grid/src/index.ts @@ -0,0 +1 @@ +export * from './autogrid.js'; diff --git a/packages/ts/react-grid/test/autogrid.tsx b/packages/ts/react-grid/test/autogrid.tsx new file mode 100644 index 0000000000..8790ec2434 --- /dev/null +++ b/packages/ts/react-grid/test/autogrid.tsx @@ -0,0 +1,21 @@ +import { expect, use } from '@esm-bundle/chai'; +import sinon from 'sinon'; +import sinonChai from 'sinon-chai'; +import { useAutoGrid as _useAutoGrid } from '../src/autogrid.js'; + +use(sinonChai); + +describe('@hilla/react-form', () => { + type UseAutoGridSpy = sinon.SinonSpy, ReturnType>; + const useAutoGrid = sinon.spy(_useAutoGrid) as typeof _useAutoGrid; + + beforeEach(() => { + (useAutoGrid as UseAutoGridSpy).resetHistory(); + }); + + describe('useAutoGrid', () => { + it('exists', async () => { + expect(useAutoGrid()).to.equal('foo'); + }); + }); +}); diff --git a/packages/ts/react-grid/tsconfig.build.json b/packages/ts/react-grid/tsconfig.build.json new file mode 100644 index 0000000000..445f3f4492 --- /dev/null +++ b/packages/ts/react-grid/tsconfig.build.json @@ -0,0 +1,8 @@ +{ + "extends": "./tsconfig.json", + "compilerOptions": { + "rootDir": "src", + "outDir": "." + }, + "include": ["src"] +} diff --git a/packages/ts/react-grid/tsconfig.json b/packages/ts/react-grid/tsconfig.json new file mode 100644 index 0000000000..440ed221a9 --- /dev/null +++ b/packages/ts/react-grid/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "../../../tsconfig.json", + "compilerOptions": { + "jsx": "react-jsx", + "experimentalDecorators": true, + "target": "es2022" + }, + "include": ["src", "test"], + "exclude": ["test/**/*.snap.ts"] +}