feat: add readme and license

LICENSE

@@ -0,0 +1,176 @@
+                                 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

README-zh.md

@@ -0,0 +1,104 @@
+# **univer-clipsheet-core**
+
+**univer-clipsheet-core** 是 **Univer Clipsheet** 功能的核心实现。该包将功能模块划分为多个独立的子模块，以实现更好的可扩展性和可维护性，主要包括 `workflow`、`scraper`、`ui` 和 `table`。下面是对各模块及其组件的关键使用介绍。
+
+[English](./README.md) | **简体中文**
+
+## **Workflow**
+
+### **WorkflowService**
+
+- **`WorkflowService.runWorkflow()`**
+  执行一个工作流并返回响应结果。
+
+- **`WorkflowService.onWorkflowDone()`**
+  工作流执行完成后触发的生命周期方法。
+
+## **Scraper**
+
+### **ScraperService**
+
+- **`ScraperService.runScraper()`**
+  执行爬虫并返回提取的数据。
+
+- **`ScraperService.stopScraper()`**
+  停止当前运行的爬虫。
+
+### **DrillDownService**
+
+- **`DrillDownService.runDrillDown()`**
+  执行下钻操作，捕获嵌套或详细数据。
+
+- **`DrillDownService.stopDrillDown()`**
+  停止当前运行的下钻操作。
+
+## **UI**
+
+以下服务处理与用户界面的通信和数据交换：
+
+- **`WorkflowPanelViewService`**
+  管理工作流面板中的数据和交互。
+
+- **`PopupViewService`**
+  处理弹出页面的数据交换和用户交互。
+
+- **`ClientViewService`**
+  管理面向客户端的用户界面，提供用户交互服务。
+
+- **`SidePanelViewService`**
+  提供侧边面板视图的功能，并与 UI 交换数据。
+
+## **Table**
+
+**Table** 模块负责管理用于存储和显示网页抓取结果的表格数据结构。该包包含以下功能：
+
+- **`TableService.addTable()`**
+  向系统中添加一个新表格来管理抓取的数据。
+
+- **`TableService.deleteTable()`**
+  删除系统中现有的表格。
+
+### **DataSource**
+
+每个核心服务类——**TableService**、**ScraperService** 和 **WorkflowService**——都包含一个 `dataSource` 属性。`dataSource` 是一个抽象类，定义了与实际数据交互的方法和结构。
+
+`dataSource` 设计的关键特点在于其灵活性：
+
+- 通过外部实现自定义 `dataSource`，可以根据需求灵活操作数据。
+- 开发者可以实现自己的数据处理逻辑，比如将数据保存到数据库、在存储数据前进行处理，或者与第三方数据系统进行集成。
+
+### **DataSource 使用示例**
+
+每个服务类提供了一个默认的 `dataSource`，但您可以在创建或配置服务时，定义并传入您自己的自定义实现。
+
+```javascript
+// 创建自定义 DataSource 的示例
+class CustomDataSource extends ITableDataSource {
+    constructor() {
+        super();
+    }
+
+  // 实现数据操作所需的方法
+    add(data) {
+    // 自定义添加数据的逻辑
+    }
+
+    getList() {
+    // 自定义获取数据的逻辑
+    }
+
+    delete(id) {
+    // 自定义删除数据的逻辑
+    }
+}
+
+new Injector([
+    [ITableDataSource, { useClass: CustomDataSource }],
+]);
+```
+
+通过使用 `dataSource` 抽象，您可以灵活地定制数据的处理方式，确保您的爬取和工作流过程能够顺利地与系统的其他部分集成。
+
+## 许可证
+
+本项目基于 **MIT License** 授权。详细信息请参阅 [LICENSE](./LICENSE) 文件。

README.md

@@ -0,0 +1,106 @@
+# **univer-clipsheet-core**
+
+**univer-clipsheet-core** is the core implementation of the **Univer Clipsheet** functionality. This package is organized into separate modules for better scalability and maintainability, including `workflow`, `scraper`, `ui`, and `table`. Below, we introduce the key usage of each module and its components.
+
+**English** | [简体中文](./README-zh.md)
+
+## **Workflow**
+
+### **WorkflowService**
+
+- **`WorkflowService.runWorkflow()`**
+  Executes a workflow and returns the response.
+
+- **`WorkflowService.onWorkflowDone()`**
+  This lifecycle method is invoked once a workflow has completed execution.
+
+## **Scraper**
+
+### **ScraperService**
+
+- **`ScraperService.runScraper()`**
+  Runs a scraper and returns the extracted data.
+
+- **`ScraperService.stopScraper()`**
+  Stops the execution of a currently running scraper.
+
+### **DrillDownService**
+
+- **`DrillDownService.runDrillDown()`**
+  Executes a drill-down operation to capture nested or detailed data.
+
+- **`DrillDownService.stopDrillDown()`**
+  Stops a currently running drill-down operation.
+
+## **UI**
+
+The following services handle communication and data exchange with the user interface:
+
+- **`WorkflowPanelViewService`**
+  Manages the data and interactions within the workflow panel.
+
+- **`PopupViewService`**
+  Handles the data exchange and user interactions for the popup view.
+
+- **`ClientViewService`**
+  Manages the client-facing UI, providing services for user interaction.
+
+- **`SidePanelViewService`**
+  Provides functionality for the side panel view and exchanges data with the UI.
+
+## **Table**
+
+The **Table** module is responsible for managing tabular data structures used to store and display the results of web scraping. This package includes the following functions:
+
+- **`TableService.addTable()`**
+  Adds a new table to the system for managing scraped data.
+
+- **`TableService.deleteTable()`**
+  Deletes an existing table from the system.
+
+### **DataSource**
+
+Each of the core service classes — **TableService**, **ScraperService**, and **WorkflowService** — has a `dataSource` property. The `dataSource` is an abstract class that defines the methods and structure for interacting with the actual data.
+
+The key aspect of the `dataSource` design is its flexibility:
+
+- The `dataSource` can be customized by passing an external implementation to each service.
+- This allows developers to implement their own data handling logic, such as saving data to a database, processing data before storing it, or integrating with third-party data systems.
+
+### Example Usage of DataSource
+
+Each service class provides a default dataSource, but you can define and pass your own custom implementation when creating or configuring the service.
+
+```javascript
+// Example of creating a custom DataSource
+class CustomDataSource extends ITableDataSource {
+    constructor() {
+        super();
+    }
+
+  // Implement required methods for data operations
+    add(data) {
+    // Custom logic for adding data
+    }
+
+    getList() {
+    // Custom logic for retrieving data
+    }
+
+    delete(id) {
+    // Custom logic for deleting data
+    }
+}
+
+new Injector([
+    [ITableDataSource, { useClass: CustomDataSource }],
+]);
+
+```
+
+By using the `dataSource` abstraction, you gain the flexibility to tailor how data is handled and ensure that your scraping and workflow processes integrate smoothly with the rest of your system.
+
+## Contact
+
+Have questions or feedback?
+Feel free to open an issue on GitHub or reach out to us via email: **[[email protected]](mailto:[email protected])**.