@fxri/swagger2api 1.2.4 → 1.2.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.
package/CHANGELOG.md ADDED
@@ -0,0 +1,191 @@
1
+ # @fxri/swagger2api
2
+
3
+ ## 1.2.6
4
+
5
+ > 2026-09-06 发布
6
+
7
+ ### 🐛 补丁修复
8
+
9
+ - 升级生产依赖 glob 至 v13,修复依赖漏洞与 deprecated 告警,CLI 行为无变化
10
+
11
+ ## 1.2.5
12
+
13
+ > 2026-09-05 发布
14
+
15
+ ### 🐛 补丁修复
16
+
17
+ - 发布清单补充 CHANGELOG.md 与 LICENSE,npm 包内可直接查看更新日志与许可信息
18
+
19
+ ## 1.2.4
20
+
21
+ > 2026-09-04 发布
22
+
23
+ ### 🐛 补丁修复
24
+
25
+ - 优化:移除项目内 @fxri/toolkit 依赖,工程化能力(任务管理、变更集、发版)统一改用全局安装的 toolkit(1.6.1),包产物无任何变化
26
+
27
+ ## 1.2.3
28
+
29
+ > 2026-09-04 发布
30
+
31
+ ### 🐛 补丁修复
32
+
33
+ - 同步重发:内容与 1.2.2 完全一致(1.2.2 发版后远端冲突回滚,经 cherry-pick 线性重放重新合入 master,本版以新版本号重发),无新增功能改动
34
+
35
+ ## 1.2.2
36
+
37
+ > 2026-09-04 发布
38
+
39
+ ### 🐛 补丁修复
40
+
41
+ - 文档:更新方弦 ® 注册商标信息(商标状态由申请中更新为已核准注册,第 42 类注册号 89648411);优化:升级 @fxri/toolkit 至 1.6.1(含 tasks archive 双重 CR 换行修复)
42
+
43
+ ## 1.2.1
44
+
45
+ > 2026-09-03 发布
46
+
47
+ ### 🐛 补丁修复
48
+
49
+ - 依赖升级:axios 1.12 → 1.20、swagger-typescript-api 13.2 → 13.12、tsup 8.5.0 → 8.5.1、@fxri/toolkit 1.1.3 → 1.3.0
50
+
51
+ ## 1.2.0
52
+
53
+ > 2026-09-03 发布
54
+
55
+ ### ✨ 新增功能
56
+
57
+ - 接入 @fxri/toolkit:新增 changesets 变更集发版流程与 .tasks 任务管理(纯工程化,不影响 API)
58
+
59
+ ## 1.1.13
60
+
61
+ > 2026-04-17 发布
62
+
63
+ ### ✨ 新增功能
64
+
65
+ - 移除空组件定义(--remove-empty-components 参数)
66
+
67
+ ## 1.1.12
68
+
69
+ > 2025-12-05 发布
70
+
71
+ ### 🐛 补丁修复
72
+
73
+ - 提取参数时将可能存在的引号包含在内
74
+
75
+ ## 1.1.11
76
+
77
+ > 2025-10-15 发布
78
+
79
+ ### 🐛 补丁修复
80
+
81
+ - 提取响应接口改为 AxiosResponse
82
+
83
+ ## 1.1.10
84
+
85
+ > 2025-10-15 发布
86
+
87
+ ### 🐛 补丁修复
88
+
89
+ - 提取响应接口改为 AxiosResponseRaw
90
+
91
+ ## 1.1.9
92
+
93
+ > 2025-10-15 发布
94
+
95
+ ### ✨ 新增功能
96
+
97
+ - 替换标签:支持 2 个参数(正则表达式 + 替换字符串)
98
+
99
+ ## 1.1.8
100
+
101
+ > 2025-10-13 发布
102
+
103
+ ### 🐛 补丁修复
104
+
105
+ - 提取响应模板配置错误
106
+
107
+ ## 1.1.7
108
+
109
+ > 2025-10-13 发布
110
+
111
+ ### 🐛 补丁修复
112
+
113
+ - 打包逻辑
114
+
115
+ ## 1.1.6
116
+
117
+ > 2025-10-13 发布
118
+
119
+ ### ✨ 新增功能
120
+
121
+ - 提取响应:将 AxiosResponse 返回值转移到 raw 字段,根部字段自行定义
122
+ - 提取参数:将 query 参数中的指定对象字段提取为根部字段,支持多选
123
+
124
+ ## 1.1.5
125
+
126
+ > 2025-10-12 发布
127
+
128
+ ### 🐛 补丁修复
129
+
130
+ - debug 模式使用更精简的配置
131
+
132
+ ## 1.1.4
133
+
134
+ > 2025-10-12 发布
135
+
136
+ ### 🐛 补丁修复
137
+
138
+ - 默认开启扫描全部配置文件
139
+
140
+ ## 1.1.3
141
+
142
+ > 2025-10-12 发布
143
+
144
+ ### 🐛 补丁修复
145
+
146
+ - 读取配置文件前先初始化参数
147
+
148
+ ## 1.1.2
149
+
150
+ > 2025-10-12 发布
151
+
152
+ ### 🐛 补丁修复
153
+
154
+ - 调整 --remove-dts 参数
155
+
156
+ ## 1.1.1
157
+
158
+ > 2025-10-12 发布
159
+
160
+ ### ✨ 新增功能
161
+
162
+ - 多文档配置,默认文档改为 saconfig.json
163
+
164
+ ## 1.1.0
165
+
166
+ > 2025-10-12 发布
167
+
168
+ ### ✨ 新增功能
169
+
170
+ - 引入 tsup 构建,支持 cjs / esm / dts 多格式产物
171
+
172
+ ### 🐛 补丁修复
173
+
174
+ - 拆分脚本入口,接口生成改用导入执行
175
+
176
+ ## 1.0.15
177
+
178
+ > 2025-10-11 发布
179
+
180
+ ### ✨ 新增功能
181
+
182
+ - 快速模式:直接使用配置文件参数
183
+ - 支持 -rd 移除使用 --js 参数时生成的 d.ts 文件
184
+
185
+ ## 1.0.0
186
+
187
+ > 2025-10-07 发布
188
+
189
+ ### 🚨 重大变更
190
+
191
+ - 首个版本:上传项目,完成基于 swagger-typescript-api 的接口代码生成基础功能
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2025 唐启云
3
+ Copyright © 2025-2026 唐启云
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/NOTICE ADDED
@@ -0,0 +1,9 @@
1
+ @fxri/swagger2api
2
+ Copyright © 2025-2026 唐启云. All rights reserved.
3
+
4
+ 出品方:方弦研究所(唐启云个人项目品牌,非独立法人实体)
5
+
6
+ 商标声明:
7
+ "方弦®"为第42类注册商标(注册号89648411),核定服务项目:计算机出租、计算机软件设计、为他人研究和开发新产品、计算机软件维护、把有形的数据或文件转换成电子媒体、为他人创建和维护网站、网络服务器出租、提供互联网搜索引擎、托管计算机站(网站)、云计算。
8
+ 本开源许可(MIT License)不授予商标使用权。
9
+ 详见 TRADEMARK.md 了解完整商标信息。
package/README.md CHANGED
@@ -206,10 +206,14 @@ npx @fxri/swagger2api [--replace-tags,-rt <regexp> <substr>]
206
206
 
207
207
  作者:唐启云 <tqy@fxri.net>
208
208
 
209
- 版权:Copyright © 2025-2026 方弦研究所. All rights reserved.
209
+ 出品:方弦研究所
210
+
211
+ 版权:Copyright © 2025-2026 唐启云. All rights reserved.
210
212
 
211
213
  网站:[方弦研究信息网](https://fxri.net:444/)
212
214
 
213
215
  协议:[MIT License](./LICENSE)
214
216
 
215
- 商标:"方弦®"为第42类注册商标(注册号89648411),本开源许可不授予商标使用权,详见 [TRADEMARK.md](./TRADEMARK.md)
217
+ 商标:"方弦®"为第42类注册商标(注册号89648411),本开源许可不授予商标使用权,详见 [TRADEMARK.md](./TRADEMARK.md)
218
+
219
+ > 方弦研究所为唐启云个人项目品牌与出品方,非独立法人实体;本软件著作权归唐启云所有。
package/TRADEMARK.md ADDED
@@ -0,0 +1,41 @@
1
+ # 商标声明
2
+
3
+ ## 基本信息
4
+
5
+ | 项目 | 内容 |
6
+ |---|---|
7
+ | 商标名称 | 方弦® |
8
+ | 商标类型 | 文字商标 |
9
+ | 商标说明 | 商标由文字"方弦"组成 |
10
+ | 商标类别 | 第42类(共10项) |
11
+ | 注册号 | 89648411 |
12
+ | 申请人 | 唐启云 |
13
+ | 递交商标局 | 2026-01-12 |
14
+ | 版本 | 基础版 |
15
+
16
+ ## 第42类服务项目
17
+
18
+ 计算机出租;计算机软件设计;为他人研究和开发新产品;计算机软件维护;把有形的数据或文件转换成电子媒体;为他人创建和维护网站;网络服务器出租;提供互联网搜索引擎;托管计算机站(网站);云计算。
19
+
20
+ ## 权利状态
21
+
22
+ "方弦®"商标(注册号89648411)已获中国国家知识产权局商标局核准注册,核定使用于第42类上述服务项目,现为注册商标。
23
+
24
+ ## 授权范围
25
+
26
+ 本仓库的开源许可证(MIT License)仅授予代码的使用、修改和分发权利,**不构成对任何商标、服务标记或品牌名称的授权许可**。
27
+
28
+ 任何派生作品、修改版本、商业产品均不得使用"方弦"名称、Logo 或相关标识,除非获得书面授权。
29
+
30
+ ## 使用规范
31
+
32
+ - 在开源社区讨论、文档引用中提及本项目时,可使用"方弦®"指代本项目名称
33
+ - 未经书面授权,不得在任何商业产品、服务或宣传材料中使用"方弦"标识
34
+
35
+ ## 获取授权
36
+
37
+ 如需将"方弦"商标用于商业用途,请联系:唐启云 <tqy@fxri.net>
38
+
39
+ ## 侵权处理
40
+
41
+ 如发现未经授权使用"方弦®"商标的行为,请通过上述联系方式举报。
@@ -1,32 +1,32 @@
1
- <%
2
- const { utils, config, routes, modelTypes } = it;
3
- const { _, pascalCase } = utils;
4
- const dataContracts = config.modular ? _.map(modelTypes, "name") : [];
5
- %>
6
-
7
- <% if (dataContracts.length) { %>
8
- import { <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataContracts %>"
9
- <% } %>
10
-
11
- <%
12
- /* TODO: outOfModule, combined should be attributes of route, which will allow to avoid duplication of code */
13
- %>
14
-
15
- <% if (routes.outOfModule) { %>
16
- <% for (const { routes: outOfModuleRoutes = [] } of routes.outOfModule) { %>
17
- <% for (const route of outOfModuleRoutes) { %>
18
- <%~ includeFile('./route-type.ejs', { ...it, route }) %>
19
- <% } %>
20
- <% } %>
21
- <% } %>
22
-
23
- <% if (routes.combined) { %>
24
- <% for (const { routes: combinedRoutes = [], moduleName } of routes.combined) { %>
25
- export namespace <%~ pascalCase(moduleName) %> {
26
- <% for (const route of combinedRoutes) { %>
27
- <%~ includeFile('./route-type.ejs', { ...it, route }) %>
28
- <% } %>
29
- }
30
-
31
- <% } %>
32
- <% } %>
1
+ <%
2
+ const { utils, config, routes, modelTypes } = it;
3
+ const { _, pascalCase } = utils;
4
+ const dataContracts = config.modular ? _.map(modelTypes, "name") : [];
5
+ %>
6
+
7
+ <% if (dataContracts.length) { %>
8
+ import { <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataContracts %>"
9
+ <% } %>
10
+
11
+ <%
12
+ /* TODO: outOfModule, combined should be attributes of route, which will allow to avoid duplication of code */
13
+ %>
14
+
15
+ <% if (routes.outOfModule) { %>
16
+ <% for (const { routes: outOfModuleRoutes = [] } of routes.outOfModule) { %>
17
+ <% for (const route of outOfModuleRoutes) { %>
18
+ <%~ includeFile('./route-type.ejs', { ...it, route }) %>
19
+ <% } %>
20
+ <% } %>
21
+ <% } %>
22
+
23
+ <% if (routes.combined) { %>
24
+ <% for (const { routes: combinedRoutes = [], moduleName } of routes.combined) { %>
25
+ export namespace <%~ pascalCase(moduleName) %> {
26
+ <% for (const route of combinedRoutes) { %>
27
+ <%~ includeFile('./route-type.ejs', { ...it, route }) %>
28
+ <% } %>
29
+ }
30
+
31
+ <% } %>
32
+ <% } %>
@@ -1,15 +1,15 @@
1
- <%
2
- const { contract, utils } = it;
3
- const { formatDescription, require, _ } = utils;
4
-
5
- %>
6
- <% if (contract.$content.length) { %>
7
- export type <%~ contract.name %> = {
8
- <% for (const field of contract.$content) { %>
9
- <%~ includeFile('./object-field-jsdoc.ejs', { ...it, field }) %>
10
- <%~ field.field %>;
11
- <% } %>
12
- }<%~ utils.isNeedToAddNull(contract) ? ' | null' : ''%>
13
- <% } else { %>
14
- export type <%~ contract.name %> = Record<string, any>;
15
- <% } %>
1
+ <%
2
+ const { contract, utils } = it;
3
+ const { formatDescription, require, _ } = utils;
4
+
5
+ %>
6
+ <% if (contract.$content.length) { %>
7
+ export type <%~ contract.name %> = {
8
+ <% for (const field of contract.$content) { %>
9
+ <%~ includeFile('./object-field-jsdoc.ejs', { ...it, field }) %>
10
+ <%~ field.field %>;
11
+ <% } %>
12
+ }<%~ utils.isNeedToAddNull(contract) ? ' | null' : ''%>
13
+ <% } else { %>
14
+ export type <%~ contract.name %> = Record<string, any>;
15
+ <% } %>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fxri/swagger2api",
3
- "version": "1.2.4",
3
+ "version": "1.2.6",
4
4
  "description": "基于 swagger-typescript-api,将 Swagger 文档自动转为 TypeScript 格式的 API 文件。",
5
5
  "license": "MIT",
6
6
  "author": {
@@ -14,6 +14,10 @@
14
14
  "files": [
15
15
  "dist",
16
16
  "README.md",
17
+ "CHANGELOG.md",
18
+ "LICENSE",
19
+ "TRADEMARK.md",
20
+ "NOTICE",
17
21
  "package.json"
18
22
  ],
19
23
  "keywords": [
@@ -23,15 +27,15 @@
23
27
  ],
24
28
  "dependencies": {
25
29
  "axios": "^1.20.0",
26
- "glob": "^11.0.3",
30
+ "glob": "^13.0.6",
27
31
  "prompts": "^2.4.2",
28
32
  "swagger-typescript-api": "^13.12.6"
29
33
  },
30
34
  "devDependencies": {
31
- "@types/node": "^20.19.21",
35
+ "@types/node": "^20.19.43",
32
36
  "@types/prompts": "^2.4.9",
33
- "@typescript-eslint/eslint-plugin": "^6.21.0",
34
- "@typescript-eslint/parser": "^6.21.0",
37
+ "@typescript-eslint/eslint-plugin": "^8.69.0",
38
+ "@typescript-eslint/parser": "^8.69.0",
35
39
  "cross-env": "^10.1.0",
36
40
  "esbuild-plugin-copy": "^2.1.1",
37
41
  "eslint": "^8.57.1",