cm-reporting 0.1.0

package/LICENSE

@@ -0,0 +1,75 @@
+# PolyForm Noncommercial License 1.0.0
+
+<https://polyformproject.org/licenses/noncommercial/1.0.0>
+
+Required Notice: Copyright (c) 2026 CM contributors
+
+## Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose.  However, you may only distribute the software according to [Distribution License](#distribution-license) and make changes or new works based on the software according to [Changes and New Works License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of the software.  Your license to distribute covers distributing the software with changes and new works permitted by [Changes and New Works License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution is use for a permitted purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else.  These terms do not imply any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice.  Otherwise, all your licenses end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization.  **Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.

package/README.md

@@ -0,0 +1,110 @@
+# cm-reporting
+
+基于 React + Ant Design 的冲突矿产报告（RMI 模板）开箱即用嵌入式应用组件库，支持 CMRT / EMRT / CRT / AMRT 的全版本覆盖。
+
+## 安装
+
+```bash
+npm install cm-reporting
+# 或
+pnpm add cm-reporting
+```
+
+## 使用（开箱即用）
+
+```tsx
+import { CMReporting } from 'cm-reporting'
+import 'cm-reporting/styles.css'
+
+export function App() {
+  return (
+    <CMReporting
+      templateType="cmrt"
+      versionId="6.5"
+      locale="zh-CN"
+      onSnapshotChange={(snapshot) => {
+        // 全量 JSON：建议宿主自行节流 + 落库/上报
+        console.log(snapshot)
+      }}
+    />
+  )
+}
+```
+
+## JSON（全量快照）
+
+- 数据契约：`ReportSnapshotV1`（含 `schemaVersion/templateType/versionId/data`）
+- 工具：`parseSnapshot()` / `stringifySnapshot()`
+
+组件 ref 方式（推荐用于“导出/保存/回填”）：
+
+```tsx
+import { CMReporting, type CMReportingRef } from 'cm-reporting'
+import { useRef } from 'react'
+
+export function App() {
+  const ref = useRef<CMReportingRef>(null)
+
+  return (
+    <>
+      <button onClick={() => console.log(ref.current?.getSnapshot())}>Export JSON</button>
+      <CMReporting ref={ref} templateType="cmrt" versionId="6.5" locale="en-US" />
+    </>
+  )
+}
+```
+
+## Excel（基于模板赋值导出）
+
+严格要求：打开 Excel 后视觉/校验（DV）/公式行为一致，因此导出采用“基于原始 RMI 模板最小差异赋值后导出”的策略。
+
+对外 API：
+
+- `exportToExcel({ templateXlsx, snapshot })`
+- `ref.exportExcel({ templateXlsx })`
+
+示例（浏览器下载）：
+
+```tsx
+import { CMReporting, type CMReportingRef } from 'cm-reporting'
+import { useRef } from 'react'
+
+async function downloadBlob(blob: Blob, filename: string) {
+  const url = URL.createObjectURL(blob)
+  const a = document.createElement('a')
+  a.href = url
+  a.download = filename
+  a.click()
+  URL.revokeObjectURL(url)
+}
+
+export function App() {
+  const ref = useRef<CMReportingRef>(null)
+
+  const onExportExcel = async () => {
+    // 模板来源由宿主决定：可从你们的静态资源/CDN，或从包导出的 templates 复制到你的 public。
+    const res = await fetch('/templates/RMI_CMRT_6.5.xlsx')
+    const templateXlsx = await res.arrayBuffer()
+    const blob = await ref.current!.exportExcel({ templateXlsx })
+    await downloadBlob(blob, 'cmrt-6.5.xlsx')
+  }
+
+  return (
+    <>
+      <button onClick={onExportExcel}>Export Excel</button>
+      <CMReporting ref={ref} templateType="cmrt" versionId="6.5" locale="en-US" />
+    </>
+  )
+}
+```
+
+## 模板文件
+
+包内导出静态模板文件：`cm-reporting/templates/*`（用于宿主自持有/下载/二次分发）。
+
+## License
+
+PolyForm-Noncommercial-1.0.0
+
+- 禁止商业用途（Noncommercial only）。
+- 如需商业使用，请联系版权所有者获取单独商业授权。