@ichinese/open-sdk 1.0.0-rc.3 → 1.0.0-rc.5

package/README.md

@@ -1,6 +1,6 @@
 # iChinese Open Platform SDK for Node.js
 
-> **Prerelease 1.0.0-rc.3.** 这是预发布版，开放平台还没有正式开放，SDK 的默认地址可能连不上。This is a prerelease: the open platform is not open to the public yet, so the SDK's default address may not answer.
+> **Prerelease 1.0.0-rc.5.** 这是预发布版，开放平台还没有正式开放，SDK 的默认地址可能连不上。This is a prerelease: the open platform is not open to the public yet, so the SDK's default address may not answer.
 
 爱中文开放平台的 Node.js 服务端 SDK：开放接口（`/open-apis/v1`）的每个接口都是一个方法，并处理令牌、重试、分页和事件推送。
 
@@ -113,6 +113,18 @@ Guides and the API reference: <https://open.ichinese.cn>
 This repository is generated from the platform's monorepo at each release, so a change made here would be
 overwritten; please open an issue instead.
 
+## Phone number and email scopes
+
+Declare `phone` and/or `email` in the developer console and release the app configuration.
+Each user decides on each scope separately. The backend's `getUserInfo` (Python: `get_user_info`,
+Go: `GetUserInfo`) returns `phone_number` (E.164) and/or `email` only for scopes both declared
+and granted, and only for currently verified, bound identifiers. Otherwise the field is absent,
+including after revocation. Neither scope requires `profile`.
+
+For the web JS SDK's browser fallback, include the declared scopes in `config({ appId, scopes: ['phone', 'email'] })`.
+In a container the consent sheet uses the app's declared scopes. Exchange the code and call the user-info
+API on your backend; keep the user token there.
+
 ## License
 
 MIT

package/dist/gen/meta.d.ts

@@ -1,10 +1,10 @@
 /** The SDK's version (it follows the open API's). */
-export declare const VERSION = "1.0.0-rc.3";
+export declare const VERSION = "1.0.0-rc.5";
 /** The open API's address from the release configuration (sdks/release.json); `baseUrl` overrides it. */
 export declare const DEFAULT_BASE_URL = "https://open.ichinese.cn";
 export declare const API_PREFIX = "/open-apis/v1";
 /** Every scope (permission code) of the open API. */
-export declare const SCOPES: readonly ["openid", "profile", "org:member:readonly", "org:member", "class:readonly", "class:member", "schedule:readonly", "schedule", "attendance:readonly", "coursework", "grade:readonly", "course", "learning:progress:readonly", "im:message:send_as_bot", "im:chat:readonly", "notify:send", "live:recording:readonly", "event", "event:registration:readonly", "job", "job:candidate:readonly", "trial", "trade:order:readonly", "trade:booking:readonly", "venue:readonly", "venue", "opening:readonly", "review", "profile:interest:readonly", "profile:interest", "profile:learning:readonly", "report:create", "community:post", "me:schedule:readonly", "me:learning:readonly", "me:words:readonly", "me:words", "insights:readonly"];
+export declare const SCOPES: readonly ["openid", "profile", "phone", "email", "org:member:readonly", "org:member", "class:readonly", "class:member", "schedule:readonly", "schedule", "attendance:readonly", "coursework", "grade:readonly", "course", "learning:progress:readonly", "im:message:send_as_bot", "im:chat:readonly", "notify:send", "live:recording:readonly", "event", "event:registration:readonly", "job", "job:candidate:readonly", "trial", "trade:order:readonly", "trade:booking:readonly", "venue:readonly", "venue", "opening:readonly", "review", "profile:interest:readonly", "profile:interest", "profile:learning:readonly", "report:create", "community:post", "me:schedule:readonly", "me:learning:readonly", "me:words:readonly", "me:words", "insights:readonly"];
 export type Scope = (typeof SCOPES)[number];
 /** The events an app can subscribe to. */
 export declare const EVENT_TYPES: readonly ["app.installed", "app.uninstalled", "app.scopes_changed", "coursework.submitted", "grade.published", "schedule.session_changed", "event.registered", "job.candidate_applied", "trade.order_paid", "review.created", "trial.booked", "im.message_received", "class.member_changed", "course.completed", "exam.results_released", "event.checked_in", "live.recording_ready", "trade.order_refunded", "trial.confirmed", "trial.cancelled", "community.post_reviewed", "community.video_ready", "booking.changed"];
@@ -16,6 +16,8 @@ export type ErrorReason = (typeof ERROR_REASONS)[number];
 export declare const OPERATION_TOKENS: Record<string, readonly ('app' | 'tenant' | 'user')[]>;
 export declare const SCOPE_OPENID = "openid";
 export declare const SCOPE_PROFILE = "profile";
+export declare const SCOPE_PHONE = "phone";
+export declare const SCOPE_EMAIL = "email";
 export declare const SCOPE_ORG_MEMBER_READONLY = "org:member:readonly";
 export declare const SCOPE_ORG_MEMBER = "org:member";
 export declare const SCOPE_CLASS_READONLY = "class:readonly";

package/dist/gen/schema.d.ts

@@ -56,7 +56,7 @@ export interface paths {
          *     两种码都接受：
          *     - **网页免登的授权码**：应用网页在桌面端或手机 App 里调 JS SDK 的 `requestAuthCode()` 拿到，带区前缀、
          *       5 分钟、只能用一次、绑定这个应用和页面来源；不用传 `redirect_uri`。
-         *     - **标准 OIDC 的授权码**：普通浏览器里 JS SDK 退回签发方 `/authorize`（先 `prompt=none` 静默）拿到的码；
+         *     - **标准 OIDC 的授权码**：普通浏览器里 JS SDK 退回签发方 `/auth`（先 `prompt=none` 静默）拿到的码；
          *       要传当时的 `redirect_uri`（和登记的一致），公开客户端用了 PKCE 时传 `code_verifier`。
          *     网关按码的区前缀转到用户的归属区。码过期返回 400 `details.reason = code_expired`，用过返回 400 `code_used`，
          *     不是这个应用的码返回 400 `code_invalid`。
@@ -114,7 +114,7 @@ export interface paths {
         };
         /**
          * 当前用户（用户令牌）
-         * @description 总有 `open_id`；`name`、`avatar_url`、`locale` 要用户批了 `profile`。
+         * @description 总有 `open_id`；`name`、`avatar_url`、`locale` 要用户批了 `profile`。应用声明且用户同意 `phone` / `email` 后，分别返回当前已验证绑定的 `phone_number` / `email`；未声明、未同意、已撤回或未绑定时省略对应字段。两项权限互不依赖，也不依赖 `profile`。
          */
         get: operations["getUserInfo"];
         put?: never;
@@ -1416,7 +1416,7 @@ export interface components {
         /** @description 权限码（目录见 `ScopeCode`；平台的 `GET /api/v1/open/scopes` 返回带说明的目录） */
         Scope: string;
         /** @enum {string} */
-        ScopeCode: "openid" | "profile" | "org:member:readonly" | "org:member" | "class:readonly" | "class:member" | "schedule:readonly" | "schedule" | "attendance:readonly" | "coursework" | "grade:readonly" | "course" | "learning:progress:readonly" | "im:message:send_as_bot" | "im:chat:readonly" | "notify:send" | "live:recording:readonly" | "event" | "event:registration:readonly" | "job" | "job:candidate:readonly" | "trial" | "trade:order:readonly" | "trade:booking:readonly" | "venue:readonly" | "venue" | "opening:readonly" | "review" | "profile:interest:readonly" | "profile:interest" | "profile:learning:readonly" | "report:create" | "community:post" | "me:schedule:readonly" | "me:learning:readonly" | "me:words:readonly" | "me:words" | "insights:readonly";
+        ScopeCode: "openid" | "profile" | "phone" | "email" | "org:member:readonly" | "org:member" | "class:readonly" | "class:member" | "schedule:readonly" | "schedule" | "attendance:readonly" | "coursework" | "grade:readonly" | "course" | "learning:progress:readonly" | "im:message:send_as_bot" | "im:chat:readonly" | "notify:send" | "live:recording:readonly" | "event" | "event:registration:readonly" | "job" | "job:candidate:readonly" | "trial" | "trade:order:readonly" | "trade:booking:readonly" | "venue:readonly" | "venue" | "opening:readonly" | "review" | "profile:interest:readonly" | "profile:interest" | "profile:learning:readonly" | "report:create" | "community:post" | "me:schedule:readonly" | "me:learning:readonly" | "me:words:readonly" | "me:words" | "insights:readonly";
         /** @enum {string} */
         OrgRole: "owner" | "admin" | "academic" | "editor" | "content_reviewer" | "teacher" | "community" | "recruiter" | "member";
         AppCredentials: {
@@ -1455,6 +1455,13 @@ export interface components {
             name?: string;
             avatar_url?: string | null;
             locale?: string;
+            /** @description 应用声明且用户同意 phone 时返回当前已验证绑定的手机号（E.164）；否则省略 */
+            phone_number?: string;
+            /**
+             * Format: email
+             * @description 应用声明且用户同意 email 时返回当前已验证绑定的邮箱；否则省略
+             */
+            email?: string;
         };
         Tenant: {
             tenant_key: components["schemas"]["TenantKey"];
@@ -2672,6 +2679,15 @@ export interface operations {
             };
             401: components["responses"]["Unauthenticated"];
             429: components["responses"]["RateLimited"];
+            /** @description SERVICE_UNAVAILABLE，归属区身份服务暂时不可用 */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
         };
     };
     getTenant: {

package/dist/index.cjs

@@ -34,6 +34,7 @@ __export(index_exports, {
   SCOPE_COMMUNITY_POST: () => SCOPE_COMMUNITY_POST,
   SCOPE_COURSE: () => SCOPE_COURSE,
   SCOPE_COURSEWORK: () => SCOPE_COURSEWORK,
+  SCOPE_EMAIL: () => SCOPE_EMAIL,
   SCOPE_EVENT: () => SCOPE_EVENT,
   SCOPE_EVENT_REGISTRATION_READONLY: () => SCOPE_EVENT_REGISTRATION_READONLY,
   SCOPE_GRADE_READONLY: () => SCOPE_GRADE_READONLY,
@@ -53,6 +54,7 @@ __export(index_exports, {
   SCOPE_OPENING_READONLY: () => SCOPE_OPENING_READONLY,
   SCOPE_ORG_MEMBER: () => SCOPE_ORG_MEMBER,
   SCOPE_ORG_MEMBER_READONLY: () => SCOPE_ORG_MEMBER_READONLY,
+  SCOPE_PHONE: () => SCOPE_PHONE,
   SCOPE_PROFILE: () => SCOPE_PROFILE,
   SCOPE_PROFILE_INTEREST: () => SCOPE_PROFILE_INTEREST,
   SCOPE_PROFILE_INTEREST_READONLY: () => SCOPE_PROFILE_INTEREST_READONLY,
@@ -123,12 +125,14 @@ var OpenApiError = class extends Error {
 var isOpenApiError = (e) => e instanceof OpenApiError;
 
 // src/gen/meta.ts
-var VERSION = "1.0.0-rc.3";
+var VERSION = "1.0.0-rc.5";
 var DEFAULT_BASE_URL = "https://open.ichinese.cn";
 var API_PREFIX = "/open-apis/v1";
 var SCOPES = [
   "openid",
   "profile",
+  "phone",
+  "email",
   "org:member:readonly",
   "org:member",
   "class:readonly",
@@ -312,6 +316,8 @@ var OPERATION_TOKENS = {
 };
 var SCOPE_OPENID = "openid";
 var SCOPE_PROFILE = "profile";
+var SCOPE_PHONE = "phone";
+var SCOPE_EMAIL = "email";
 var SCOPE_ORG_MEMBER_READONLY = "org:member:readonly";
 var SCOPE_ORG_MEMBER = "org:member";
 var SCOPE_CLASS_READONLY = "class:readonly";
@@ -1243,6 +1249,7 @@ var challengeResponse = (v) => ({ challenge: v.challenge });
   SCOPE_COMMUNITY_POST,
   SCOPE_COURSE,
   SCOPE_COURSEWORK,
+  SCOPE_EMAIL,
   SCOPE_EVENT,
   SCOPE_EVENT_REGISTRATION_READONLY,
   SCOPE_GRADE_READONLY,
@@ -1262,6 +1269,7 @@ var challengeResponse = (v) => ({ challenge: v.challenge });
   SCOPE_OPENING_READONLY,
   SCOPE_ORG_MEMBER,
   SCOPE_ORG_MEMBER_READONLY,
+  SCOPE_PHONE,
   SCOPE_PROFILE,
   SCOPE_PROFILE_INTEREST,
   SCOPE_PROFILE_INTEREST_READONLY,

package/dist/index.js

@@ -43,12 +43,14 @@ var OpenApiError = class extends Error {
 var isOpenApiError = (e) => e instanceof OpenApiError;
 
 // src/gen/meta.ts
-var VERSION = "1.0.0-rc.3";
+var VERSION = "1.0.0-rc.5";
 var DEFAULT_BASE_URL = "https://open.ichinese.cn";
 var API_PREFIX = "/open-apis/v1";
 var SCOPES = [
   "openid",
   "profile",
+  "phone",
+  "email",
   "org:member:readonly",
   "org:member",
   "class:readonly",
@@ -232,6 +234,8 @@ var OPERATION_TOKENS = {
 };
 var SCOPE_OPENID = "openid";
 var SCOPE_PROFILE = "profile";
+var SCOPE_PHONE = "phone";
+var SCOPE_EMAIL = "email";
 var SCOPE_ORG_MEMBER_READONLY = "org:member:readonly";
 var SCOPE_ORG_MEMBER = "org:member";
 var SCOPE_CLASS_READONLY = "class:readonly";
@@ -1162,6 +1166,7 @@ export {
   SCOPE_COMMUNITY_POST,
   SCOPE_COURSE,
   SCOPE_COURSEWORK,
+  SCOPE_EMAIL,
   SCOPE_EVENT,
   SCOPE_EVENT_REGISTRATION_READONLY,
   SCOPE_GRADE_READONLY,
@@ -1181,6 +1186,7 @@ export {
   SCOPE_OPENING_READONLY,
   SCOPE_ORG_MEMBER,
   SCOPE_ORG_MEMBER_READONLY,
+  SCOPE_PHONE,
   SCOPE_PROFILE,
   SCOPE_PROFILE_INTEREST,
   SCOPE_PROFILE_INTEREST_READONLY,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ichinese/open-sdk",
-  "version": "1.0.0-rc.3",
+  "version": "1.0.0-rc.5",
   "description": "Server SDK for the iChinese open platform (open API, tokens, events, web login): Node.js 20+",
   "license": "MIT",
   "type": "module",