@hoanghong/speaking-core 0.4.1 → 0.4.2

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 (3) hide show
  1. package/CHANGELOG.md +5 -1
  2. package/README.md +8 -10
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,6 +1,10 @@
1
+ ## 0.4.2
2
+
3
+ - Simplify public integration documentation; no runtime changes.
4
+
1
5
  # 0.4.1
2
6
 
3
- - CMS-managed application keys share PostgreSQL quota, rotation and revocation.
7
+ - Application keys support quota updates, rotation and revocation.
4
8
  - Optional public-service baseUrl for private deployments and local integration.
5
9
  - Includes microphone selection and realtime audio backpressure fixes (web SDK).
6
10
 
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @hoanghong/speaking-core
2
2
 
3
- SDK online cho người tự làm UI. Bản test 0.4.1 cài bằng `npm install ./vendor/hoanghong-speaking-core-0.4.1.tgz` từ bộ ZIP, chưa publish registry. Angular dùng @hoanghong/speaking-angular với component có sẵn; Flutter dùng fsel_speaking. MIT.
3
+ SDK online cho người tự làm UI. Bản test 0.4.2 cài bằng `npm install ./vendor/hoanghong-speaking-core-0.4.2.tgz` từ bộ ZIP, chưa publish registry. Angular dùng @hoanghong/speaking-angular với component có sẵn; Flutter dùng fsel_speaking. MIT.
4
4
 
5
5
  ## Đánh giá phát âm tiếng Anh Mỹ
6
6
 
@@ -78,17 +78,15 @@ createSpeakingGateway và các constructor cấu hình thủ công cũ vẫn đ
78
78
  Dùng `createSpeakingService({ appKey: "KEY_DUOC_FSEL_CAP" })` thay cho lời gọi không tham số. SDK gửi key khi cấp phiên; quota quản lý phía server, không có URL cần cấu hình. Key này là định danh ứng dụng có thể quan sát ở frontend, không có quyền quản trị. INVALID_APP_KEY/401 nghĩa là sai hoặc đã bị khóa; không tự fallback ẩn danh.
79
79
 
80
80
 
81
- ## CMS application keys (0.4.1)
81
+ ## Application key and service URL
82
82
 
83
- Create an application key in CMS > API Keys, then pass it as `appKey`.
84
- The CMS backend and SDK endpoint must share the same PostgreSQL DATABASE_URL.
85
- Quota changes, key rotation and disabling are enforced by the backend. Existing
86
- sessions are also checked against key state. App keys identify quota; they do not
87
- grant CMS administrator access and are visible in browser/mobile applications.
83
+ Pass the application key provided by FSEL as `appKey`. Quotas and key status are
84
+ managed by the service. App keys identify an application and are visible in
85
+ browser/mobile applications.
88
86
 
89
- The hosted default remains https://ai-service.fsel.edu.vn/sdk. A custom deployment
90
- can set `baseUrl` to its absolute /sdk endpoint (never /admin/api).
87
+ The default service is https://ai-service.fsel.edu.vn/sdk. For a private deployment,
88
+ set `baseUrl` to the absolute /sdk endpoint supplied by your service operator.
91
89
 
92
90
  ```ts
93
- createSpeakingService({ appKey: 'KEY_FROM_CMS', baseUrl: 'https://your-service.example/sdk' });
91
+ createSpeakingService({ appKey: 'YOUR_APP_KEY', baseUrl: 'https://your-service.example/sdk' });
94
92
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hoanghong/speaking-core",
3
- "version": "0.4.1",
3
+ "version": "0.4.2",
4
4
  "description": "Online speaking SDK: gateway configuration, realtime microphone and audio upload",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",