rj-grid 0.1.0

package/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.

package/README.md

@@ -0,0 +1,92 @@
+# rj-grid
+
+自研**零第三方依赖**的企业级数据网格（Vue 3 + TypeScript），功能规格对标 AG Grid：虚拟滚动、冻结列、行/列拖拽、分组透视、树形、编辑与撤销、公式引擎、SSRM 服务端行模型、主题与 i18n、打印/CSV/Excel 导出、离线自然语言查询（NLQ）。gzip 约 93 KB（不含 vue / echarts）。
+
+本仓库是该组件的**独立维护仓**：源码、单测、构建链、演示 playground、使用手册都在这里；宿主项目（如 join-cloud-vue3）经 npm 的 git URL 安装产物，不参与组件开发。
+
+## 仓库布局
+
+| 路径 | 作用 |
+|---|---|
+| `index.ts` | 包入口（值导出 `RjGrid` + NLQ / 查询条件内核 + 全部公共类型） |
+| `src/` | 组件与引擎源码（`src/types.ts` 是类型权威） |
+| `__tests__/` | 346 个单测用例，入口 `__tests__/run.ts` |
+| `build/rjDistCheck.mjs` | 产物体检五守卫（构建末尾自动跑） |
+| `build/rjSizeReport.mjs` | 体积报告 |
+| `vite.lib.config.ts` | 库构建：ESM 单文件 + 单 `style.css`，external `vue`/`echarts`，不出 sourcemap |
+| `vite.playground.config.ts` | 演示页 dev/build，`rj-grid` 别名指本地 `index.ts` |
+| `playground/` | 8 标签演示页（独立起服，不依赖宿主） |
+| `docs/RjGrid使用手册.md` | 完整使用手册（能力、API、坑与边界） |
+| `dist/` | 发布产物，**随库入库**（见「发布纪律」） |
+
+## 快速上手（维护者）
+
+```powershell
+pnpm install
+
+pnpm test      # 单测 346 passed
+pnpm ts        # vue-tsc --noEmit（自有 tsconfig，无宿主基线噪声）
+pnpm lint      # eslint + stylelint
+pnpm build     # vite lib → vue-tsc 产 d.ts → 产物体检五守卫
+pnpm size      # 体积报告（可选）
+
+pnpm dev       # playground 演示页（默认 :5173，alias 走本地源码）
+```
+
+改完源码的发布纪律：`pnpm build` → 让源码与 `dist/` 处在**同一个 commit** → 打 tag → push。
+
+## 宿主接入（git URL）
+
+```jsonc
+// 宿主 package.json
+"dependencies": {
+  "rj-grid": "git+https://gitee.com/rjding/rj-grid.git#v0.1.0"
+}
+```
+
+样式**不要**在 JS 里裸引 `rj-grid/style.css`：pnpm 会把 git 依赖装进带 `#<commit>` 的目录名，vite 输出的资源 URL 含裸 `#`，浏览器把 `#` 之后当片段丢掉 → dev 下 404。改走一层 CSS 垫片：
+
+```css
+/* 宿主 src/styles/rjgrid/index.css */
+@import 'rj-grid/style.css';
+```
+
+```ts
+// 宿主 src/main.ts
+import '@/styles/rjgrid/index.css'
+```
+
+组件侧必须是**值导入**（`RjGrid` 不走宿主的自动组件注册，只写 type 导入会在运行期报 `Failed to resolve component: rj-grid`）：
+
+```ts
+import { RjGrid } from 'rj-grid'
+```
+
+peer 依赖：`vue ^3.4.0` 必装；`echarts >=5.0.0` 可选（仅「集成图表」用到，包内 `await import('echarts')` 动态加载）。注意宿主没装 echarts 时 `vite build` 会因 rollup 解析不到该动态 import 而失败——要么装上，要么宿主加 `build.rollupOptions.external: ['echarts']`；组件自身有降级，图表对话框会显示一行提示而非崩页。
+
+## 升级与回滚
+
+```powershell
+pnpm update rj-grid          # 跟到 URL 允许的最新 commit
+pnpm install --force         # 或改 #<tag> 后强制重装
+```
+
+lockfile 里记录的是具体 commit（`specifier` 存 tag，`resolution` 存 commit），因此 CI / 他人 `pnpm install --frozen-lockfile` 可精确复现。本地联调可把 URL 临时换成 `"link:../rjGrid"`，调完记得换回 git URL 并重装。
+
+## 为什么 dist 入库
+
+npm/pnpm 安装 git 依赖时按 `files` 字段（`["dist","README.md"]`）对仓库内容做 pack 式裁剪，**不会**在宿主机跑 `prepare` 重建。所以产物必须提交进仓库：只推源码不推 `dist/`，安装方会拿到空包。代价是 commit 里要带上产物，收益是安装期零工具链、跨机器结果一致。
+
+`build/rjDistCheck.mjs` 的五道守卫同时在把关：外部 import 只允许 `vue`/`echarts`；CSS 不引宿主资源；d.ts 不断链；dist 不得混入 `.vue/.ts/.scss` 源码；**不得带 sourcemap**——vite 的 `.map` 内嵌 `sourcesContent`（原始源码），一发包等于源码同步外流，因此 `vite.lib.config.ts` 里 `sourcemap: false` 是源码保护而非可选项。
+
+## 私有仓注意
+
+本仓库为 gitee 私有仓时，安装方机器必须具备克隆凭据（HTTPS 走 credential manager 里的 gitee 账号，或改用有权限的部署密钥）；CI 环境需预先注入凭据，否则 `pnpm install` 会卡在 git 认证。
+
+## 文档
+
+完整能力、API 与已知边界见 [docs/RjGrid使用手册.md](docs/RjGrid使用手册.md)；`playground` 的 8 个标签既是能力地图也是回归入口。
+
+## 赞助
+码农不易，^V^
+![小小支援，大大的爱](docs/88888.png)