@ticatec/restful_service_api 0.3.0 → 0.5.0

package/README-CN.md

@@ -18,6 +18,34 @@
 - 🌐 **浏览器优先**: 专为前端应用程序设计
 - ✨ **PATCH 支持**: 完整支持 HTTP PATCH 方法进行部分更新
 
+## ⚠️ v0.5.0 重大变更
+
+**从 0.5.0 版本开始，此包已迁移到 ESM (ECMAScript Modules) 格式。**
+
+### 对您的影响
+
+- 您的项目必须使用 ESM 格式（package.json 中包含 `"type": "module"` 或使用 `.mjs` 扩展名）
+- 不再支持 `require()`，请使用 `import` 语句
+
+### 迁移指南
+
+如果您正在从 0.5.0 之前的版本升级：
+
+**之前 (CommonJS):**
+```javascript
+const RestService = require('@ticatec/restful_service_api');
+```
+
+**之后 (ESM):**
+```typescript
+import RestService from '@ticatec/restful_service_api';
+```
+
+对于 CommonJS 项目，您可能需要使用动态导入：
+```javascript
+const { default: RestService } = await import('@ticatec/restful_service_api');
+```
+
 ## 安装
 
 ```bash

package/README.md

@@ -18,6 +18,33 @@ A lightweight TypeScript RESTful API client for browsers with comprehensive erro
 - 🌐 **Browser-First**: Designed specifically for frontend applications
 - ✨ **PATCH Support**: Full support for HTTP PATCH method for partial updates
 
+## ⚠️ Breaking Changes in v0.5.0
+
+**Starting from version 0.5.0, this package has migrated to ESM (ECMAScript Modules) format.**
+
+### What This Means for You
+
+- Your project must use ESM format (have `"type": "module"` in package.json or use `.mjs` extension)
+- `require()` is no longer supported. Use `import` statements instead
+### Migration Guide
+
+If you're upgrading from a version prior to 0.5.0:
+
+**Before (CommonJS):**
+```javascript
+const RestService = require('@ticatec/restful_service_api');
+```
+
+**After (ESM):**
+```typescript
+import RestService from '@ticatec/restful_service_api';
+```
+
+For CommonJS projects, you may need to use dynamic import:
+```javascript
+const { default: RestService } = await import('@ticatec/restful_service_api');
+```
+
 ## Installation
 
 ```bash

package/package.json

@@ -1,7 +1,8 @@
 {
+  "type": "module",
   "name": "@ticatec/restful_service_api",
-  "version": "0.3.0",
-  "description": "A lightweight TypeScript RESTful API client for browsers with error handling.",
+  "version": "0.5.0",
+  "description": "A lightweight TypeScript RESTful API client for browsers with error handling. (ESM only, v0.5.0+)",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",