zentao-api 0.6.0 → 0.6.1

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 (22) hide show
  1. package/README.md +16 -0
  2. package/dist/browser/zentao-api.global.js +2 -2
  3. package/dist/index.d.ts +1 -1
  4. package/dist/misc/errors.d.ts +5 -0
  5. package/dist/misc/errors.js +5 -0
  6. package/dist/modules/export.d.ts +3 -1
  7. package/dist/modules/export.js +1 -0
  8. package/dist/modules/generated.d.ts +3 -0
  9. package/dist/modules/generated.js +3 -1
  10. package/dist/modules/registry.d.ts +3 -0
  11. package/dist/request/index.d.ts +3 -3
  12. package/dist/request/index.js +6 -1
  13. package/dist/request/prepare-body.d.ts +12 -0
  14. package/dist/request/prepare-body.js +221 -0
  15. package/dist/types/index.d.ts +1 -0
  16. package/dist/types/index.js +1 -0
  17. package/dist/types/module.d.ts +6 -0
  18. package/dist/types/options.d.ts +2 -0
  19. package/dist/types/upload.d.ts +38 -0
  20. package/dist/types/upload.js +1 -0
  21. package/dist/version.js +2 -2
  22. package/package.json +1 -1
package/README.md CHANGED
@@ -160,6 +160,22 @@ result.data?.forEach((product) => console.log(product.name));
160
160
  const raw = await request('product/list', {}, { raw: true });
161
161
  ```
162
162
 
163
+ ### 上传附件
164
+
165
+ Node.js/Bun 可以直接把本地文件路径交给高阶 `request()`；SDK 会根据模块注册表构造 `multipart/form-data`。浏览器中请传 `File` 或 `Blob`，不能传本地路径。
166
+
167
+ ```ts
168
+ const uploaded = await request('file/create', {
169
+ file: '/tmp/zentao-api-upload.txt',
170
+ objectType: 'story',
171
+ objectID: 1,
172
+ });
173
+
174
+ console.log(uploaded.data?.id, uploaded.data?.url);
175
+ ```
176
+
177
+ 单个本地文件或 Blob 默认限制为 50 MiB；可通过单次调用选项 `maxUploadBytes` 调整。
178
+
163
179
  ### 底层 REST 客户端
164
180
 
165
181
  `ZentaoClient` 适合直接调用 API v2 路径：