npm - neo-cmp-cli - Versions diffs - 1.8.3 → 1.8.6 - Mend

neo-cmp-cli 1.8.3 → 1.8.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (189) hide show

package/template/react-custom-cmp-template/public/template.html ADDED Viewed

@@ -0,0 +1,13 @@
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="format-detection" content="telephone=no"/>
+  <meta name="viewport" content="initial-scale=1.0,user-scalable=no,width=device-width,viewport-fit=cover">
+  <meta http-equiv="X-UA-Compatible" content="ie=edge">
+  <title>自定义组件预览页</title>
+</head>
+<body>
+  <div id="root"></div>
+</body>
+</html>

package/template/react-custom-cmp-template/src/assets/css/common.scss ADDED Viewed

@@ -0,0 +1,127 @@
+/* 公共的自定义函数 */
+@function px2vw($px, $screen-width: 750) {
+  @return ($px / $screen-width) * 100vw;
+}
+@function px2rem($px, $remRate: 100) {
+  @return ($px / $remRate) + rem;
+}
+@function px2vmin($px, $screen-width: 750) {
+  @return ($px / $screen-width) * 100vmin;
+}
+@mixin fillBox {
+  width: 100%;
+  height: 100%;
+}
+/* 头部细线 */
+@mixin borderTop {
+  content: '';
+  position: absolute;
+  left: 0;
+  right: 0;
+  top: 0;
+  width: 100%;
+  height: 1px;
+  background: #ddd;
+  transform: scaleY(0.5);
+}
+/* 底部细线 */
+@mixin borderBtm {
+  content: '';
+  position: absolute;
+  left: 0;
+  right: 0;
+  bottom: 0;
+  width: 100%;
+  height: 1px;
+  background: #ddd;
+  transform: scaleY(0.5);
+}
+/* 统一的内边距 */
+@mixin unifiedPadding($value: 40) {
+  padding: 0 px2rem($value) 0 px2rem($value);
+}
+/* 统一的左内边距 */
+@mixin unifiedLeftPadding($value: 40) {
+  padding-left: px2rem($value);
+}
+/* 统一的右内边距 */
+@mixin unifiedRightPadding($value: 40) {
+  padding-right: px2rem($value);
+}
+/* 统一的底部边框样式 */
+@mixin unifiedBottomBorder {
+  border-bottom: 1px solid #ddd;
+}
+/* 统一的上边框样式 */
+@mixin unifiedTopBorder {
+  border-top: 1px solid #ddd;
+}
+/* 统一的Item高度 */
+@mixin unifiedItemHeight {
+  line-height: px2rem(120);
+  height: px2rem(120);
+}
+/* 设置行高样式 */
+@mixin setItemHeight($value: 120) {
+  line-height: px2rem($value);
+  height: px2rem($value);
+}
+/* 统一的Item样式 */
+@mixin unifiedItemStyle {
+  font-family: PingFangSC-Regular;
+  font-size: px2rem(28);
+  color: #828282;
+  letter-spacing: 0;
+}
+/* 统一的弹性盒子样式 */
+@mixin unifiedFlexBoxStyle {
+  display: flex;
+  flex-wrap: nowrap;
+  justify-content: center;
+  align-items: center;
+}
+/* 统一的Title样式 */
+@mixin unifiedTitleStyle {
+  font-family: PingFangSC-Regular;
+  font-size: px2rem(40);
+  color: #1e1e1e;
+}
+/* 统一的内容样式 */
+@mixin unifiedContentStyle {
+  font-family: PingFangSC-Regular;
+  font-size: px2rem(28);
+  color: #1e1e1e;
+  letter-spacing: 0;
+  text-align: right;
+  line-height: px2rem(28);
+}
+/* 底部导航盒子样式 */
+@mixin fixedBottomBox {
+  position: fixed;
+  left: 0;
+  bottom: 0;
+  width: 100%;
+}
+// 常用的变量
+$background-color: #fafafa;
+$border-color: #f7f7f7;
+$page-padding-top: px2rem(20);

package/template/react-custom-cmp-template/src/assets/css/mixin.scss ADDED Viewed

@@ -0,0 +1,47 @@
+// 通用mixin
+$borderColor: #ddd;
+// type 为top 或者 bottom
+@mixin borderTopOrBtm($type) {
+  &::after {
+    content: '';
+    position: absolute;
+    left: 0;
+    right: 0;
+    #{$type}: 0;
+    width: 100%;
+    height: 1px;
+    background: $borderColor;
+    transform: scaleY(0.5);
+  }
+}
+// type为 right 或者 left
+@mixin borderRtOrLt($type) {
+  &::after {
+    content: '';
+    position: absolute;
+    top: 0;
+    bottom: 0;
+    #{$type}: 0;
+    height: 100%;
+    width: 1px;
+    background: $borderColor;
+    transform: scaleX(0.5);
+  }
+}
+//超出1行显示...
+@mixin ellipsis1 {
+  overflow: hidden;
+  text-overflow: ellipsis;
+  white-space: nowrap;
+}
+// 超出多行显示...
+@mixin ellipsis($num) {
+  overflow: hidden;
+  display: -webkit-box;
+  -webkit-line-clamp: $num;
+  -webkit-box-orient: vertical;
+}

package/template/react-custom-cmp-template/src/assets/img/NeoCRM.jpg ADDED Viewed

Binary file

package/template/react-custom-cmp-template/src/assets/img/custom-widget.svg ADDED Viewed

@@ -0,0 +1 @@

+ <?xml version="1.0" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg t="1756957113315" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="5395" xmlns:xlink="http://www.w3.org/1999/xlink" width="200" height="200"><path d="M288 768v115.2c0 25.6 19.2 44.8 44.8 44.8h556.8c25.6 0 44.8-19.2 44.8-44.8v-198.4s0-6.4-6.4-6.4h-83.2c-38.4 0-70.4-32-70.4-70.4 0-38.4 32-70.4 70.4-70.4h83.2s6.4 0 6.4-6.4V332.8c0-25.6-19.2-44.8-44.8-44.8H768C768 198.4 697.6 128 608 128S448 198.4 448 288H332.8c-25.6 0-44.8 19.2-44.8 44.8V448C198.4 448 128 518.4 128 608S198.4 768 288 768z m0-249.6h70.4V358.4h160V288c0-51.2 38.4-89.6 89.6-89.6 51.2 0 89.6 38.4 89.6 89.6v70.4h160v108.8h-19.2c-76.8 0-140.8 64-140.8 140.8 0 76.8 64 140.8 140.8 140.8h19.2v108.8H358.4v-160H288c-51.2 0-89.6-38.4-89.6-89.6 0-51.2 38.4-89.6 89.6-89.6z" p-id="5396" fill="#0764f5"></path></svg>

package/template/react-custom-cmp-template/src/assets/img/favicon.png ADDED Viewed

Binary file

package/template/react-custom-cmp-template/src/components/infoCard/index.jsx ADDED Viewed

@@ -0,0 +1,45 @@
+import * as React from 'react';
+import './style.scss'; // 组件内容样式
+export default class InfoCard extends React.PureComponent {
+  constructor() {
+    super();
+    this.agreeDataFormat = this.agreeDataFormat.bind(this);
+  }
+  agreeDataFormat(agreeData) {
+    if (agreeData && agreeData <= 9999) {
+      return agreeData;
+    }
+    if (agreeData && agreeData > 9999) {
+      return `${Math.floor(agreeData / 1000) / 10}w`;
+    }
+  }
+  render() {
+    const { title, backgroundImage, imgCount, commentCount } = this.props;
+    const curBackgroundImage =
+      backgroundImage || 'https://neo-widgets.bj.bcebos.com/NeoCRM.jpg';
+    return (
+      <div className="info-card-container">
+        <div className="news-title">
+          {title ||
+            '营销服全场景智能CRM，帮助企业搭建数字化客户经营平台，实现业绩高质量增长。'}
+        </div>
+        <div className="item-imgbox">
+          <div
+            className="news-img"
+            style={{ backgroundImage: `url(${curBackgroundImage})` }}
+          ></div>
+          {imgCount > 0 && <div className="img-count">{imgCount}</div>}
+        </div>
+        <div className="news-info">
+          <div className="left media-mark">NeoCRM · 低代码平台</div>
+          {commentCount && commentCount > 0 && (
+            <div className="cmt-num right">
+              {this.agreeDataFormat(commentCount)}评
+            </div>
+          )}
+        </div>
+      </div>
+    );
+  }
+}

package/template/react-custom-cmp-template/src/components/infoCard/model.js ADDED Viewed

@@ -0,0 +1,81 @@
+/**
+ * @file 自定义组件对接编辑器的描述文件
+ */
+export class InfoCardModel {
+  /**
+   * cmpType 为自定义组件名称，用于标识组件的唯一性
+   * 在构建时根据当前组件目录名称自动生成
+   */
+  // cmpType: string = 'infoCard';
+  // 组件名称，用于设置在编辑器左侧组件面板中展示的名称
+  label = '信息卡片';
+  // 组件描述，用于设置在编辑器左侧组件面板中展示的描述
+  description = '信息展示卡片';
+  // 分类标签，用于设置在编辑器左侧组件面板哪个分类中展示（可设置多个分类标签）
+  // tags: string[] = ['自定义组件'];
+  /**
+   * 用于设置组件支持的页面类型
+   *
+   * 当前 NeoCRM 平台存在的页面类型：
+   * all:	1	全页面
+   * indexPage:	2	首页
+   * entityListPage:	3	实体列表页
+   * entityFormPage:	4	实体表单页
+   * entityDetailPage:	5	实体详情页
+   * customPage:	6	自定义页面
+   * bizPage:	7	业务页面
+   */
+  // targetPage: string[] = ['customPage'];
+  // 组件图标，用于设置在编辑器左侧组件面板中展示的图标
+  // iconSrc = 'https://neo-widgets.bj.bcebos.com/custom-widget.svg';
+  iconSrc = 'https://neo-widgets.bj.bcebos.com/favicon.png';
+  // 初次插入页面的默认属性数据
+  defaultComProps = {
+    title:
+      '营销服全场景智能CRM，帮助企业搭建数字化客户经营平台，实现业绩高质量增长。',
+    label: '信息卡片',
+    backgroundImage: 'https://neo-widgets.bj.bcebos.com/NeoCRM.jpg',
+    imgCount: 3,
+    commentCount: 2025,
+  };
+  /**
+   * 组件面板配置，用于生成编辑器右侧属性配置面板内容
+   * 备注：自定义组件中可用的配置项类型 请见 [当前可用表单项](https://github.com/wibetter/neo-register/blob/master/docs/FormItemType.md
+   */
+  propsSchema = [
+    {
+      type: 'textarea',
+      name: 'title',
+      label: '卡片title',
+      value:
+        '营销服全场景智能CRM，帮助企业搭建数字化客户经营平台，实现业绩高质量增长。',
+    },
+    {
+      type: 'text',
+      name: 'backgroundImage',
+      label: '展示图片',
+      value: 'https://neo-widgets.bj.bcebos.com/NeoCRM.jpg',
+    },
+    {
+      type: 'number',
+      name: 'imgCount',
+      label: '图片数量',
+      value: 3,
+    },
+    {
+      type: 'number',
+      name: 'commentCount',
+      label: '评论数',
+      value: 2025,
+    },
+  ];
+}
+export default InfoCardModel;

package/template/react-custom-cmp-template/src/components/infoCard/style.scss ADDED Viewed

@@ -0,0 +1,67 @@
+.info-card-container {
+  position: relative;
+  box-sizing: border-box;
+  // border-bottom: 1px solid #ececec;
+  margin: 6px 12px;
+  padding: 6px 12px;
+  background-color: #fff;
+  .news-title {
+    padding: 6px 0;
+    font-family: PingFangSC-Regular;
+    font-size: 16px;
+    line-height: 22px;
+    color: #5f5e5e;
+  }
+  .item-imgbox {
+    position: relative;
+    height: 395px;
+    background: #f0f0f0;
+    cursor: pointer;
+    box-sizing: border-box;
+    text-align: center;
+    overflow: hidden;
+    .news-img {
+      width: 100%;
+      height: 100%;
+      box-sizing: border-box;
+      background-size: contain;
+    }
+    .img-count {
+      position: absolute;
+      top: 0;
+      right: 0;
+      padding: 6px 8px;
+      color: #fff;
+      min-width: 60px;
+      text-align: center;
+      line-height: 1.2;
+      background: rgba(0, 0, 0, 0.4);
+      font-size: 25px;
+      box-sizing: border-box;
+      overflow: hidden;
+    }
+  }
+  .news-info {
+    font-family: PingFangSC-Light;
+    height: 28px;
+    box-sizing: border-box;
+    display: flex;
+    justify-content: space-between;
+    align-items: center;
+  }
+  .media-mark,
+  .cmt-num {
+    display: inline-block;
+    height: 28px;
+    line-height: 28px;
+    font-family: PingFangSC-Light;
+    font-size: 18px;
+    color: #828282;
+  }
+}

package/template/react-ts-custom-cmp-template/.prettierrc.js ADDED Viewed

@@ -0,0 +1,12 @@
+/*
+  prettier 配置文件
+  更多配置信息：https://prettier.io/docs/en/options.html
+ */
+module.exports = {
+  semi: true, // Semicolons 分号，默认需要分号
+  tabWidth: 2, // 空格，默认 2,
+  useTabs: false,
+  singleQuote: true, // 单引号还是双引号，默认为false 双引号
+  trailingComma: 'all', // 逗号
+  jsxBracketSameLine: false, // 默认为false，Put the > of a multi-line JSX element at the end of the last line instead of being alone on the next line (does not apply to self closing elements).
+};

package/template/react-ts-custom-cmp-template/README.md ADDED Viewed

@@ -0,0 +1,154 @@
+### 目录说明
+- src: 自定义组件源码；
+- src/assets: 存放组件静态资源，比如 css、img等；
+- src/components: 存放自定义组件代码，每个自定义组件以自身名称（cmpType 数值）作为目录进行存放；
+- src/components/xxCmp/index: 自定义组件的内容文件；
+- src/components/xxCmp/model: 自定义组件的模型文件，用于对接页面设计器；
+- neo.config.js: neo-cmp-cli 配置文件。
+### 组件开发规范
+- 存放在 src/components 目录下的自定义组件，默认 index 为自定义组件源码入口文件，register.[tj]s 为注册 自定义组件的脚本文件，model.[tj]s 为自定义组件的模型文件（对接页面设计器需要）；
+- 当 neo.config.js 中的 entry 为空或者不存在时，cli 将根据 src/components 目录下的自定义组件结构生成对应的 entry 配置（可在命令控制台查看生成的 entry 配置）；
+- 自定义组件中可用的配置项类型 请见 [当前可用表单项](https://github.com/wibetter/neo-register/blob/master/docs/FormItemType.md)；
+- 自定义组件最外层请设置一个唯一的 ClassName（比如 xx-cmpType-container），所有内容样式请放在该 ClassName 中，避免自定义组件样式相互干扰；
+- 默认开启代码规范检测（含样式内容），如需关闭，请调整 neo.config.js 相关配置；
+- 请使用 react 16版本。
+### 自定义组件注册器使用说明
+- [neo-register 使用说明](https://www.npmjs.com/package/neo-register?activeTab=readme)
+备注：预览、调试（linkDebug）和构建发布时 cli 会自动创建对应的注册文件（含 neo-register 的使用），用户无需关注 neo-register。
+### 开发说明
+1. **安装依赖**
+```bash
+$ npm i 或者 yarn
+```
+2. **preview: 组件预览模式（带热更新）**
+> preview模式：用于预览自定义组件内容。
+```bash
+$ npm run preview
+```
+3. **linkDebug: 外链调试（在线上页面设计器端预览自定义组件）**
+> linkDebug模式：用于在线上页面设计器中预览和调试自定义组件。
+```bash
+$ npm run linkDebug
+```
+4. **发布到 NeoCRM 平台**
+> 需要确保 package.json 中的 name 值唯一，version 值不重复。
+```bash
+$ npm run pushCmp
+```
+### 🔐 授权配置
+使用 `neo push cmp`、`neo pull cmp`、`neo delete cmp` 等命令与 NeoCRM 平台交互时，需要配置授权信息。
+#### 方式一：OAuth2 登录授权（推荐）
+OAuth2 授权码模式更加安全可靠，无需用户配置账户名和密码。
+##### 使用步骤
+1. **登录 NeoCRM 平台**
+   ```bash
+   neo login
+   ```
+   执行流程：
+   - 自动打开浏览器访问授权页面
+   - 在浏览器中输入 NeoCRM 账号密码进行登录（需选择对应的租户）
+   - 授权成功后自动跳转回本地（附带 code）
+   - cli 端 通过 code 获取 Token，并自动保存到项目的 `.neo-cli/token.json` 文件中
+2. **登出 NeoCRM 平台**
+   ```bash
+   neo logout
+   ```
+   功能：清除本地保存的 token 文件，下次使用需要重新登录。
+##### 配置示例
+```javascript
+// neo.config.js
+module.exports = {
+  neoConfig: {
+    neoBaseURL: 'https://crm-cd.xiaoshouyi.com', // 平台根地址（默认：https://crm.xiaoshouyi.com）
+    // 登录授权 URL（用于获取 code）
+    loginURL: 'https://login-cd.xiaoshouyi.com/auc/oauth2/auth',
+    tokenAPI: 'https://login-cd.xiaoshouyi.com/auc/oauth2/token', // Token 获取接口地址
+  },
+}
+```
+##### Token 有效期
+- **access_token**：默认有效期 2 小时
+- **refresh_token**：默认有效期 30 天
+- 系统会在 access_token 过期前 5 分钟自动刷新
+- 如果 refresh_token 也过期，需要重新执行 `neo login`
+##### 常见问题
+**Q1: 浏览器无法自动打开怎么办？**
+A: 命令行会输出授权 URL，手动复制到浏览器中打开即可。
+**Q2: Token 刷新失败怎么办？**
+A: 如果 refresh_token 也过期（默认 30 天），需要重新执行 `neo login`。同时检查网络连接是否正常。
+**Q3: 授权登录后没有正常跳回 redirect_uri**
+A: 可能被浏览器安装的插件影响，目前已知会影响授权登录的浏览器插件有：Neo UI Extension，请关闭插件后重试。
+#### 方式二：密码授权配置
+在项目根目录的 `neo.config.js` 文件中添加 NeoCRM 平台授权配置：
+```javascript
+module.exports = {
+  neoConfig: {
+    neoBaseURL: 'https://crm-cd.xiaoshouyi.com', // 平台根地址（默认：https://crm.xiaoshouyi.com）
+    tokenAPI: 'https://login-cd.xiaoshouyi.com/auc/oauth2/token', // Token 获取接口地址
+    // NeoCRM 授权配置
+    auth: {
+      client_id: 'xx', // 客户端 ID，从创建连接器的客户端信息中获取（Client_Id）
+      client_secret: 'xxx', // 客户端秘钥，从创建连接器的客户端信息中获取（Client_Secret）
+      username: 'xx', // 用户在销售易系统中的用户名
+      /**
+       * password 为 用户在销售易系统中的账号密码加上 8 位安全令牌。
+       * 例如，用户密码为 123456，安全令牌为 ABCDEFGH，则 password 的值应为 123456ABCDEFGH。
+       */
+      password: 'xx xx' // 用户账户密码 + 8 位安全令牌
+    },
+  },
+}
+```
+##### 授权配置获取方式
+1. **客户端 ID 和客户端秘钥**：需通过创建连接器获取
+   - 访问 [销售易文档中心](https://doc.xiaoshouyi.com) / 创建连接器
+   - 创建连接器后，从客户端信息中获取 `Client_Id` 和 `Client_Secret`
+2. **安全令牌**：如何获取安全令牌
+   - 访问 [销售易文档中心](https://doc.xiaoshouyi.com) / OAuth安全认证 / 密码模式 / 获取令牌
+   - 按照文档说明获取 8 位安全令牌
+   - `password` 字段 = 用户账户密码 + 8 位安全令牌（直接拼接，无空格或分隔符）
+#### OAuth2 模式 vs 密码模式
+| 特性 | OAuth2 授权码模式 | 密码模式 |
+|------|------------------|---------|
+| 安全性 | ✅ 高（无需在配置文件中存储密码） | ⚠️ 较低（需要配置密码和安全令牌） |
+| Token 刷新 | ✅ 自动刷新 | ✅ 自动刷新 |
+| 有效期 | 2 小时（可自动刷新） | 永不过期 |
+| 推荐程度 | ⭐⭐⭐⭐⭐ | ⭐⭐⭐ |
+---
+### 配置项说明（neo-cmp-cli）
+[请查看neo-cmp-cli](https://www.npmjs.com/package/neo-cmp-cli)

package/template/react-ts-custom-cmp-template/commitlint.config.js ADDED Viewed

@@ -0,0 +1,59 @@
+/**
+ * https://www.npmjs.com/package/@commitlint/config-conventional\
+ *
+ * Git提交规范-配置文件
+ * Commit message 由Header、Body 和 Footer三个部分组成，其格式如下：
+ *  <type>(<scope>): <subject>
+ *  <BLANK LINE>
+ *   <body>
+ *  <BLANK LINE>
+ *  <footer>
+ *
+ *【备注】
+ * type 用于说明 commit 的类别，常用下面 7 个标识：
+ * scope 用于说明当前功能点作用于哪个页面或者哪个功能模块；
+ * subject 用于简短的描述当前commit，不超过50个字符；
+ * body 用于填写对本次 commit 的详细描述，可以分成多行；
+ * footer 不兼容变动声明，或者关闭 Issue。
+ *
+ * 【type类型取值类型】
+ * feat：新功能（feature）
+ * fix：功能优化
+ * bug：修补bug
+ * docs：文档（documentation）
+ * style：格式（不影响代码运行的变动）
+ * refactor：重构（即不是新增功能，也不是修改bug的代码变动）
+ * test：增加测试
+ * chore：构建过程或辅助工具的变动
+ * build：影响构建系统或外部依赖项的更改（示例范围：gulp，broccoli，npm）
+ * ci：对 CI 配置文件和脚本的更改（示例范围：Travis，Circle，BrowserStack，SauceLabs）
+ * perf：改进性能的代码更改
+ *
+ */
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'type-enum': [
+      2,
+      'always',
+      [
+        'feat',
+        'fix',
+        'bug',
+        'docs',
+        'style',
+        'refactor',
+        'test',
+        'chore',
+        'perf',
+        'build',
+        'ci',
+      ],
+    ],
+    'type-empty': [2, 'never'],
+    'scope-empty': [1, 'never'],
+    'subject-full-stop': [0, 'never'],
+    'subject-case': [0, 'never'],
+  },
+};