share-light 0.0.5 → 1.0.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023 novlan1
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,4 +1,13 @@
-## 分享 SDK
+# 分享 SDK
+
+<p align="center">
+  <img src="https://img.shields.io/npm/dw/share-light">
+  <img src="https://img.shields.io/npm/unpacked-size/share-light">
+  <img src="https://img.shields.io/npm/v/share-light">
+  <img src="https://img.shields.io/npm/l/share-light">
+  <img src="https://img.shields.io/github/last-commit/novlan1/plugin-light">
+  <img src="https://img.shields.io/github/created-at/novlan1/plugin-light">
+</p>
 
 轻量级的分享 SDK。支持以下渠道
 
@@ -7,11 +16,11 @@
 3. QQ、微信
 4. 其他，包括系统浏览器
 
-### 1. 如何使用
+## 1. 如何使用
 
 可直接引入，也可异步加载。
 
-#### 1.1. 直接引入
+### 1.1. 直接引入
 
 安装：
 
@@ -36,7 +45,7 @@ initShare({
 openShareUI();
 ```
 
-#### 1.2. 异步加载
+### 1.2. 异步加载
 
 也可异步加载，并使用其提供的全局变量 `shareLightSDK`，性能更佳。
 
@@ -101,8 +110,7 @@ export function setupWzydShare(url: string) {
 }
 ```
 
-
-### 2. 类型
+## 2. 类型
 
 ```ts
 export const SHARE_TYPE_MAP = {
@@ -164,8 +172,7 @@ export interface ShareUIObject {
 }
 ```
 
-
-### 3. 内部配置
+## 3. 内部配置
 
 默认分享图片和提示文案等，可通过 `initShare` 参数覆盖。
 
@@ -181,15 +188,13 @@ export const DEFAULT_TIP_MAP = {
 };
 ```
 
-### 4. 更新日志
+## 4. 更新日志
 
 [点此查看](./CHANGELOG.md)
 
+## 5. 制作背景
 
-### 5. 制作背景
-
-
-#### 5.1. 当前痛点
+### 5.1. 当前痛点
 
 1. 引入了`jsapi`，体积太大，文件太多，可读性、可维护性太差。本来就是非常简单的东西，加载`sdk`、调用全局变量即可，现在变得非常麻烦
 2. 类型缺失，使用、阅读、开发、调试困难
@@ -213,7 +218,7 @@ export const DEFAULT_TIP_MAP = {
 <img src="https://mike-1255355338.cos.ap-guangzhou.myqcloud.com/article/2025/3/own_mike_d45c10acbf304f3975.png" width="600">
 
 
-#### 5.2. 优化思路
+### 5.2. 优化思路
 
 1. 去掉 `jsapi`
 2. 补充类型提示
@@ -231,7 +236,7 @@ export const DEFAULT_TIP_MAP = {
 6. `getEnvVersion` 去掉，没找到需要它的地方
 7. `isTestEnv`，同样去掉
 
-### 6. 效果
+## 6. 效果
 
 减少 `85KB`。
 
@@ -243,9 +248,7 @@ export const DEFAULT_TIP_MAP = {
 
 <img src="https://mike-1255355338.cos.ap-guangzhou.myqcloud.com/article/2025/3/own_mike_8f266681fa965b8410.png" width="600">
 
-
-
-### 7. 其他
+## 7. 其他
 
 更新为异步后，每次修改 `share-light`，需要：
 

package/lib/index.js

@@ -378,8 +378,7 @@
   };
 
   /**
-   * @export formatUrlParams
-   * @description 根据传入的参数，移除原来的所有参数，根据传入的 keepParamsObj 进行重新拼接地址，以 hash 模式返回
+   * 根据传入的参数，移除原来的所有参数，根据传入的 keepParamsObj 进行重新拼接地址，以 hash 模式返回
    * @param {string} url 地址
    * @param {object} keepParamsObj 参数对象
    * @returns 只有传入参数的地址
@@ -438,8 +437,7 @@
   }
 
   /**
-   * @export resolveUrlParams
-   * @description 提取链接参数，兼容hash模式和history模式，以及拼接异常情况
+   * 提取链接参数，兼容hash模式和history模式，以及拼接异常情况
    * @param {string} [url=''] 地址
    * @param {string} [key=''] 可选，若不为空，则提取返回该key对应的参数值
    * @returns 地址参数对象，或者是指定参数值

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "share-light",
-  "version": "0.0.5",
+  "version": "1.0.0",
   "description": "轻量级的分享SDK",
   "keywords": [
     "plugin-light",
     "share-light",
     "share-sdk"
   ],
-  "homepage": "https://novlan1.github.io/plugin-light/zh/share-light.html",
+  "homepage": "https://novlan1.github.io/docs/plugin-light/zh/share-light.html",
   "bugs": {
     "url": "https://github.com/novlan1/plugin-light/issues"
   },
@@ -16,14 +16,14 @@
     "url": "https://github.com/novlan1/plugin-light"
   },
   "license": "MIT",
-  "author": "guowangyang",
+  "author": "novlan1",
   "sideEffects": "false",
   "main": "./lib/index",
   "files": [
     "lib"
   ],
   "dependencies": {
-    "t-comm": "^1.5.0"
+    "t-comm": "^1.5.40"
   },
   "engines": {
     "node": "12.x || 14.x || >= 16"