@allkit/http-client 0.0.2 → 0.0.4

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@allkit/http-client",
-    "version": "0.0.1",
+    "version": "0.0.4",
     "description": "this is a http-client package",
     "type": "module",
     "main": "./http-client.umd.js",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allkit/http-client",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "this is a http-client package",
   "type": "module",
   "main": "./src/index.ts",

package/scripts/build.mjs

@@ -7,7 +7,7 @@ import fse from 'fs-extra'
 import { build } from 'vite'
 import { viteLibConfig } from '@allkit/vite-config'
 
-const { outputFile } = fse
+const { outputFile, copy } = fse
 
 const require = createRequire(import.meta.url)
 
@@ -81,14 +81,17 @@ const buildAll = async () => {
 // copy文件
 // README.md
 // 样式 index.css
-const copyFiles = () => {
+// skills 目录
+const copyFiles = async () => {
   const markdown = createReadStream(resolve(__dirname, '../README.md'))
   markdown.pipe(createWriteStream(resolve(__dirname, '../dist/README.md')))
+
+  await copy(resolve(__dirname, '../skills'), resolve(__dirname, '../dist/skills'))
 }
 
 const buildLib = async () => {
   await buildAll()
-  copyFiles()
+  await copyFiles()
 }
 
 buildLib()

package/skills/http-client/SKILL.md

@@ -0,0 +1,37 @@
+---
+name: http-client
+description: HTTP 客户端封装，支持小程序,web更多平台，统一处理 API 请求、响应和错误 / HTTP client wrapper for handling API requests
+author: allkit
+category: network
+---
+
+# @allkit/http-client
+
+HTTP 客户端，统一处理 API 请求、响应和错误。
+
+## Install
+
+```bash
+pnpm add @allkit/http-client
+```
+
+## Methods
+
+| Method | Description |
+|--------|-------------|
+| [Http.get](./references/get.md) | GET 请求 |
+| [Http.post](./references/post.md) | POST 请求 |
+| [Http.put](./references/put.md) | PUT 请求 |
+| [Http.delete](./references/delete.md) | DELETE 请求 |
+| [Http.patch](./references/patch.md) | PATCH 请求 |
+
+## Usage
+
+```ts
+import Http from '@allkit/http-client'
+
+const res = await Http.post({
+  url: '/api/user/list',
+  data: { page: 1, pageSize: 10 }
+})
+```

package/skills/http-client/examples/api.ts

@@ -0,0 +1,50 @@
+import Http from '@allkit/http-client'
+
+type UserInfo = {
+  id: number
+  name: string
+  email: string
+}
+
+type UserListParams = {
+  page: number
+  pageSize: number
+  keyword?: string
+}
+
+export const apiGetUserList = (params: UserListParams) => {
+  return Http.get<{ list: UserInfo[]; total: number }>({
+    url: '/user/list',
+    params,
+  })
+}
+
+export const apiCreateUser = (data: Omit<UserInfo, 'id'>) => {
+  return Http.post<UserInfo>({
+    url: '/user',
+    data,
+  })
+}
+
+export const apiUpdateUser = (id: number, data: Partial<UserInfo>) => {
+  return Http.put<UserInfo>({
+    url: `/user/${id}`,
+    data,
+  })
+}
+
+export const apiDeleteUser = (id: number) => {
+  return Http.delete({
+    url: `/user/${id}`,
+  })
+}
+
+export const apiUploadFile = (file: File) => {
+  const formData = new FormData()
+  formData.append('file', file)
+  return Http.post<{ url: string }>({
+    url: '/upload',
+    data: formData,
+    headers: { 'content-Type': 'multipart/form-data' },
+  })
+}

package/skills/http-client/references/delete.md

@@ -0,0 +1,17 @@
+# Http.delete
+
+发送 DELETE 请求
+
+## Signature
+
+```ts
+function delete<T = any>(config: RequestConfig): Promise<T>
+```
+
+## Example
+
+```ts
+await Http.delete({
+  url: '/api/user/1'
+})
+```

package/skills/http-client/references/get.md

@@ -0,0 +1,28 @@
+# Http.get
+
+发送 GET 请求
+
+## Signature
+
+```ts
+function get<T = any>(config: RequestConfig): Promise<T>
+```
+
+## Config
+
+| Property | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `url` | `string` | Yes | 请求地址 |
+| `params` | `object` | No | URL 参数 |
+| `headers` | `object` | No | 请求头 |
+| `timeout` | `number` | No | 超时时间 |
+| `responseType` | `string` | No | 响应类型 |
+
+## Example
+
+```ts
+const res = await Http.get<{ list: User[]; total: number }>({
+  url: '/api/user/list',
+  params: { page: 1, pageSize: 10 }
+})
+```

package/skills/http-client/references/patch.md

@@ -0,0 +1,18 @@
+# Http.patch
+
+发送 PATCH 请求
+
+## Signature
+
+```ts
+function patch<T = any>(config: RequestConfig): Promise<T>
+```
+
+## Example
+
+```ts
+const res = await Http.patch<User>({
+  url: '/api/user/1',
+  data: { name: '王五' }
+})
+```

package/skills/http-client/references/post.md

@@ -0,0 +1,27 @@
+# Http.post
+
+发送 POST 请求
+
+## Signature
+
+```ts
+function post<T = any>(config: RequestConfig): Promise<T>
+```
+
+## Config
+
+| Property | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `url` | `string` | Yes | 请求地址 |
+| `data` | `object` | No | 请求体数据 |
+| `headers` | `object` | No | 请求头 |
+| `timeout` | `number` | No | 超时时间 |
+
+## Example
+
+```ts
+const res = await Http.post<User>({
+  url: '/api/user',
+  data: { name: '张三', email: 'test@example.com' }
+})
+```

package/skills/http-client/references/put.md

@@ -0,0 +1,18 @@
+# Http.put
+
+发送 PUT 请求
+
+## Signature
+
+```ts
+function put<T = any>(config: RequestConfig): Promise<T>
+```
+
+## Example
+
+```ts
+const res = await Http.put<User>({
+  url: '/api/user/1',
+  data: { name: '李四' }
+})
+```