feat: init

sellerartifact · Jul 26, 2024 · 351c0fa · 351c0fa
1 parent fc75abb
commit 351c0fa
Show file tree

Hide file tree

Showing 13 changed files with 2,234 additions and 243 deletions.
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -4,7 +4,7 @@
   "commit": false,
   "linked": [],
   "access": "restricted",
-  "baseBranch": "main",
+  "baseBranch": "master",
   "updateInternalDependencies": "patch",
   "ignore": []
 }
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,7 +1,4 @@
 module.exports = {
   root: true,
   extends: ['@modern-js'],
-  rules: {
-    'no-param-reassign': 'off',
-  },
 };
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,35 @@
+.DS_Store
+
+.pnp
+.pnp.js
+.env.local
+.env.*.local
+.history
+*.log*
+
+node_modules/
+.yarn-integrity
+*.tsbuildinfo
+.eslintcache
+
+coverage/
+release/
+output/
+output_resource/
+tests/
+
+.vscode/**/*
+!.vscode/settings.json
+!.vscode/extensions.json
+.idea/
+
+src/
+
+modern.config.*
+jest.config.js
+.eslintrc.js
+.eslintrc
+tsconfig.json
+CHANGELOG.md
+
+**/*/api/typings/auto-generated
diff --git a/.prettierrc b/.prettierrc
@@ -1,6 +1,5 @@
 {
   "singleQuote": true,
   "trailingComma": "all",
-  "arrowParens": "avoid",
-  "endOfLine": "auto"
+  "arrowParens": "avoid"
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -16,7 +16,7 @@
     "**/node_modules": true
   },
   //
-  "editor.rulers": [],
+  "editor.rulers": [80, 120],
   "files.eol": "\n",
   "files.trimTrailingWhitespace": true,
   "files.insertFinalNewline": true,

diff --git a/README.md b/README.md
@@ -1,63 +1,40 @@
-# cn-international-express-sdk
-
-聚合云途,三态,顺丰等国际物流的 nodejs SDK
-
-<p align="center">
-    <a href="https://npmcharts.com/compare/cn-international-express-sdk?minimal=true" rel="nofollow"><img src="https://img.shields.io/npm/dm/cn-international-express-sdk.svg" style="max-width:100%;"></a>
-    <a href="https://www.npmjs.com/package/cn-international-express-sdk" rel="nofollow"><img src="https://img.shields.io/npm/v/cn-international-express-sdk.svg" style="max-width:100%;"></a>
-    <a href="https://www.npmjs.com/package/cn-international-express-sdk" rel="nofollow"><img src="https://img.shields.io/npm/l/cn-international-express-sdk.svg?style=flat" style="max-width:100%;"></a>
-</p>
-
-| 物流                                                                                                                                                                                | Package                                                             | Status |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | ------ |
-| [杰航国际](https://xt.jiehang.net/sysstyle/clientApi/New-k5-API.pdf)                                                                                                                | [@cn-international-express-sdk/jiehang](./packages/jiehang)         | ✅     |
-| [云途物流](https://yunexpress-fileupload.oss-cn-shenzhen.aliyuncs.com/%E4%BA%91%E9%80%94%E7%89%A9%E6%B5%81API%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E8%A7%84%E8%8C%83OMS20230706.pdf) | [@cn-international-express-sdk/yuntu](./packages/yuntu)             | ✅     |
-| [三态速递](https://www.sfcservice.com/webservice)                                                                                                                                   | [@cn-international-express-sdk/santai](./packages/santai)           | ✅     |
-| [菜鸟国际](https://open.cainiao.com/document?namespace=gyuvti&slug=icpyy606guebmtrq)                                                                                                | [@cn-international-express-sdk/cainiao](./packages/cainiao)         | ✅     |
-| [燕文物流](https://www.yw56.com.cn/webfile/API%E6%8E%A5%E5%8F%A3/)                                                                                                                  | [@cn-international-express-sdk/yanwen](./packages/yanwen)           | ✅     |
-| [纵横迅通国际](http://order.globleexpress.com:8051/usercenter/manager/api_document.aspx)                                                                                            | [@cn-international-express-sdk/zhxt](./packages/zhxt)               | ✅     |
-| [递一国际](https://docs.qq.com/pdf/DRnZBQW1ZRnRoQnpO?)                                                                                                                              | [@cn-international-express-sdk/cne](./packages/cne)                 | ✅     |
-| [递四方](https://open.4px.com/apiInfo/apiDetail?itemId=2&mainId=96#)                                                                                                                | [@cn-international-express-sdk/fpx](./packages/fpx)                 | ✅     |
-| [华翰物流](http://new.hh-exp.com:8181/docs/mindoc/createOrder)                                                                                                                      | [@cn-international-express-sdk/hua_han](./packages/hua_han)         | ✅     |
-| [华羽通国际](http://szhyt.rtb56.com/usercenter/manager/api_document.aspx)                                                                                                           | [@cn-international-express-sdk/hua_yu_tong](./packages/hua_yu_tong) | ✅     |
-| [顺丰国际](./assets/顺丰国际-KTS喀秋莎系统下单接口通用技术规范V4-7-20200509.docx)                                                                                                   | [@cn-international-express-sdk/kts](./packages/kts)                 | ✅     |
-| [17FEIA](https://www.17feia.com/news?id=326&from=2)                                                                                                                                 | [@cn-international-express-sdk/one7feia](./packages/one7feia)       | ✅     |
-| [万邦速达](http://apidoc.wanbexpress.com/)                                                                                                                                          | [@cn-international-express-sdk/wanb](./packages/wanb)               | ✅     |
-| [宝通达](./assets/宝通达接口.pdf)                                                                                                                                                   | [@cn-international-express-sdk/bao_tong_da](./packages/bao_tong_da) | ✅     |
-| [妥投国际](http://order.logtt.com/usercenter/manager/api_document.aspx)                                                                                                             | [@cn-international-express-sdk/tuo_tou](./packages/tuo_tou)         | ✅     |
-| [云速通达](./assets/云速通达xms.docx)                                                                                                                                               | [@cn-international-express-sdk/xms](./packages/xms)                 | ✅     |
-
-# Install
-
-```shell
-pnpm install --save cn-international-express-sdk
-
-
-// 由于项目是采用 monorepo 的方式管理的，所以也可直接安装单个物流的SDK包
-pnpm install --save @cn-international-express-sdk/santai
-pnpm install --save @cn-international-express-sdk/yuntu
+# Modern.js Package
+
+## Setup
+
+Install the dependencies:
+
+```bash
+pnpm run install
 ```
 
-# Usage
+## Get Started
+
+Run and debug the module:
 
-```typescript
-import { Yuntu, YuntuConfig } from 'cn-international-express-sdk';
+```bash
+pnpm run dev
+```
+
+Build the module for production:
 
-// 其他物流的使用方式类似
-const config: YuntuConfig = {
-  app_key: 'your_app_key',
-  app_token: 'your_app_token',
-  base_url: '这个属性为选填,默认为 http://oms.api.yunexpress.com/api/',
-};
+```bash
+pnpm run build
+```
 
-const yuntu = new Yuntu(config);
+Enable optional features:
 
-// 获取云途物流的配送渠道
-await yuntu.genRequest('GET', 'Common/GetShippingMethods');
+```bash
+pnpm run new
 ```
 
-# License
+Other commands:
 
-MIT License
+```bash
+pnpm run lint         # Lint and fix source files
+pnpm run change       # Add a new changeset
+pnpm run bump         # Update version and changelog via changeset
+pnpm run release      # Release the package
+```
 
-Copyright (c) 2023 王珏
+For more information, see the [Modern.js Module documentation](https://modernjs.dev/module-tools/en).
diff --git a/modern.config.ts b/modern.config.ts
@@ -0,0 +1,6 @@
+import { moduleTools, defineConfig } from '@modern-js/module-tools';
+
+export default defineConfig({
+  plugins: [moduleTools()],
+  buildPreset: 'npm-library',
+});
diff --git a/package.json b/package.json
@@ -1,49 +1,47 @@
 {
-  "private": true,
-  "name": "cn-international-express-sdk",
-  "license": "MIT",
+  "name": "yi_jing_tong",
+  "version": "0.1.0",
+  "types": "./dist/types/index.d.ts",
+  "main": "./dist/lib/index.js",
+  "module": "./dist/es/index.js",
   "scripts": {
-    "new": "modern new",
-    "reset": "modern clear",
+    "prepare": "modern build && husky install",
+    "dev": "modern dev",
+    "build": "modern build",
+    "build:watch": "modern build -w",
+    "reset": "rimraf ./**/node_modules",
+    "lint": "modern lint",
     "change": "modern change",
     "bump": "modern bump",
     "pre": "modern pre",
-    "prepare": "husky install",
     "change-status": "modern change-status",
     "gen-release-note": "modern gen-release-note",
     "release": "modern release",
-    "deploy": "modern deploy",
-    "lint": "modern lint",
+    "new": "modern new",
     "upgrade": "modern upgrade"
   },
-  "engines": {
-    "node": ">=16.18.1"
-  },
   "lint-staged": {
     "*.{js,jsx,ts,tsx,mjs,cjs}": [
       "node --max_old_space_size=8192 ./node_modules/eslint/bin/eslint.js --fix --color --cache --quiet"
     ]
   },
   "eslintIgnore": [
     "node_modules/",
-    "dist/",
-    ".rpt2_cache/"
+    "dist/"
   ],
-  "workspaces": {
-    "packages": [
-      "apps/*",
-      "packages/*"
-    ]
-  },
+  "dependencies": {},
+  "peerDependencies": {},
   "devDependencies": {
-    "@modern-js-app/eslint-config": "2.42.0",
-    "@modern-js/eslint-config": "2.42.0",
-    "@modern-js/monorepo-tools": "2.42.0",
-    "@modern-js/tsconfig": "2.42.0",
-    "husky": "^8.0.0",
+    "@modern-js/module-tools": "2.56.2",
+    "@modern-js/eslint-config": "2.56.2",
+    "typescript": "~5.0.4",
+    "@types/node": "~16.11.7",
+    "rimraf": "~3.0.2",
     "lint-staged": "~13.1.0",
-    "prettier": "^2.6.2"
+    "prettier": "~2.8.1",
+    "husky": "~8.0.1"
   },
+  "sideEffects": [],
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"