docs(api): update pkgs API

Author: yaonyan

CHANGELOG.md

@@ -5,18 +5,13 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 ## [2.2.1](https://github.com/ceajs/cea/compare/v2.2.0...v2.2.1) (2021-11-11)
 
-
 ### Bug Fixes
 
-* **core:** CLOUD join type result handling ([0924be8](https://github.com/ceajs/cea/commit/0924be8da53c6fcee829ea10e9d36a58e30e4ea1))
-* **core:** login process for CLOUD ([5740f84](https://github.com/ceajs/cea/commit/5740f84f1701e170e2158fc840a08db174a0075a))
-* **internal:** print school join type CLOUD | NOTCLOUD ([2264028](https://github.com/ceajs/cea/commit/226402871e2b84d8c7345428af9a40141000bd8b))
-* **notifier:** add error handling ([063c38a](https://github.com/ceajs/cea/commit/063c38a2fd54a72bba2d7fe90f67bd3c7ba6a32f))
-* presize error handling ([0759c25](https://github.com/ceajs/cea/commit/0759c25628a571e7afb12e30bc25b9825973edd6))
-
-
-
-
+- **core:** CLOUD join type result handling ([0924be8](https://github.com/ceajs/cea/commit/0924be8da53c6fcee829ea10e9d36a58e30e4ea1))
+- **core:** login process for CLOUD ([5740f84](https://github.com/ceajs/cea/commit/5740f84f1701e170e2158fc840a08db174a0075a))
+- **internal:** print school join type CLOUD | NOTCLOUD ([2264028](https://github.com/ceajs/cea/commit/226402871e2b84d8c7345428af9a40141000bd8b))
+- **notifier:** add error handling ([063c38a](https://github.com/ceajs/cea/commit/063c38a2fd54a72bba2d7fe90f67bd3c7ba6a32f))
+- presize error handling ([0759c25](https://github.com/ceajs/cea/commit/0759c25628a571e7afb12e30bc25b9825973edd6))
 
 # [2.2.0](https://github.com/ceajs/cea/compare/v2.1.0...v2.2.0) (2021-11-09)
 

core/CHANGELOG.md

@@ -5,18 +5,13 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 ## [2.2.1](https://github.com/ceajs/cea/compare/v2.2.0...v2.2.1) (2021-11-11)
 
-
 ### Bug Fixes
 
-* **core:** CLOUD join type result handling ([0924be8](https://github.com/ceajs/cea/commit/0924be8da53c6fcee829ea10e9d36a58e30e4ea1))
-* **core:** login process for CLOUD ([5740f84](https://github.com/ceajs/cea/commit/5740f84f1701e170e2158fc840a08db174a0075a))
-* **internal:** print school join type CLOUD | NOTCLOUD ([2264028](https://github.com/ceajs/cea/commit/226402871e2b84d8c7345428af9a40141000bd8b))
-* **notifier:** add error handling ([063c38a](https://github.com/ceajs/cea/commit/063c38a2fd54a72bba2d7fe90f67bd3c7ba6a32f))
-* presize error handling ([0759c25](https://github.com/ceajs/cea/commit/0759c25628a571e7afb12e30bc25b9825973edd6))
-
-
-
-
+- **core:** CLOUD join type result handling ([0924be8](https://github.com/ceajs/cea/commit/0924be8da53c6fcee829ea10e9d36a58e30e4ea1))
+- **core:** login process for CLOUD ([5740f84](https://github.com/ceajs/cea/commit/5740f84f1701e170e2158fc840a08db174a0075a))
+- **internal:** print school join type CLOUD | NOTCLOUD ([2264028](https://github.com/ceajs/cea/commit/226402871e2b84d8c7345428af9a40141000bd8b))
+- **notifier:** add error handling ([063c38a](https://github.com/ceajs/cea/commit/063c38a2fd54a72bba2d7fe90f67bd3c7ba6a32f))
+- presize error handling ([0759c25](https://github.com/ceajs/cea/commit/0759c25628a571e7afb12e30bc25b9825973edd6))
 
 # [2.2.0](https://github.com/ceajs/cea/compare/v2.1.0...v2.2.0) (2021-11-09)
 

docs/api/core/enums/CampusphereEndpoint.md

@@ -18,7 +18,7 @@
 
 #### Defined in
 
-[src/types/helper.ts:8](https://github.com/ceajs/cea/blob/08338e7/core/src/types/helper.ts#L8)
+[src/types/helper.ts:8](https://github.com/ceajs/cea/blob/137f0b9/core/src/types/helper.ts#L8)
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 #### Defined in
 
-[src/types/helper.ts:6](https://github.com/ceajs/cea/blob/08338e7/core/src/types/helper.ts#L6)
+[src/types/helper.ts:6](https://github.com/ceajs/cea/blob/137f0b9/core/src/types/helper.ts#L6)
 
 ___
 
@@ -38,4 +38,4 @@ ___
 
 #### Defined in
 
-[src/types/helper.ts:9](https://github.com/ceajs/cea/blob/08338e7/core/src/types/helper.ts#L9)
+[src/types/helper.ts:9](https://github.com/ceajs/cea/blob/137f0b9/core/src/types/helper.ts#L9)

docs/api/core/interfaces/HandleCookieOptions.md

@@ -12,10 +12,6 @@
 
 - [CampusphereEndpoint](../enums/CampusphereEndpoint.md)
 
-### Interfaces
-
-- [HandleCookieOptions](../interfaces/HandleCookieOptions.md)
-
 ### Type aliases
 
 - [CookieRawObject](../modules.md#cookierawobject)
@@ -25,7 +21,7 @@
 - [UserConfOpts](../modules.md#userconfopts)
 - [UsersConf](../modules.md#usersconf)
 
-### Properties
+### Variables
 
 - [log](../modules.md#log)
 
@@ -49,7 +45,7 @@
 
 #### Defined in
 
-[src/types/cookie.ts:3](https://github.com/ceajs/cea/blob/08338e7/core/src/types/cookie.ts#L3)
+[src/types/cookie.ts:3](https://github.com/ceajs/cea/blob/137f0b9/core/src/types/cookie.ts#L3)
 
 ___
 
@@ -63,7 +59,7 @@ ___
 
 #### Defined in
 
-[src/types/conf.ts:13](https://github.com/ceajs/cea/blob/08338e7/core/src/types/conf.ts#L13)
+[src/types/conf.ts:14](https://github.com/ceajs/cea/blob/137f0b9/core/src/types/conf.ts#L14)
 
 ___
 
@@ -76,15 +72,16 @@ ___
 | Name | Type |
 | :------ | :------ |
 | `auth` | `string` |
+| `authURL?` | `string` |
 | `campusphere` | `string` |
 | `chineseName` | `string` |
 | `defaultAddr` | `string` |
-| `isIap` | `boolean` |
+| `isCloud` | `boolean` |
 | `preAuthURL` | `string` |
 
 #### Defined in
 
-[src/types/conf.ts:17](https://github.com/ceajs/cea/blob/08338e7/core/src/types/conf.ts#L17)
+[src/types/conf.ts:18](https://github.com/ceajs/cea/blob/137f0b9/core/src/types/conf.ts#L18)
 
 ___
 
@@ -98,7 +95,7 @@ ___
 
 #### Defined in
 
-[src/types/helper.ts:1](https://github.com/ceajs/cea/blob/08338e7/core/src/types/helper.ts#L1)
+[src/types/helper.ts:1](https://github.com/ceajs/cea/blob/137f0b9/core/src/types/helper.ts#L1)
 
 ___
 
@@ -112,30 +109,41 @@ ___
 | :------ | :------ |
 | `addr` | `string`[] |
 | `alias` | `string` |
-| `cookie?` | [`CookieRawObject`](../modules.md#cookierawobject) |
+| `captcha?` | ``"MANUAL"`` \| ``"OCR"`` |
 | `password` | `string` |
 | `school` | `string` |
 | `username` | `string` |
 
 #### Defined in
 
-[src/types/conf.ts:4](https://github.com/ceajs/cea/blob/08338e7/core/src/types/conf.ts#L4)
+[src/types/conf.ts:5](https://github.com/ceajs/cea/blob/137f0b9/core/src/types/conf.ts#L5)
 
 ___
 
 ### UsersConf
 
-Ƭ **UsersConf**: [`UserConfOpts`](../modules.md#userconfopts)[]
+Ƭ **UsersConf**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `notifier?` | [\`${number}\`, `string`] |
+| `users` | [`UserConfOpts`](../modules.md#userconfopts)[] |
 
 #### Defined in
 
-[src/types/conf.ts:3](https://github.com/ceajs/cea/blob/08338e7/core/src/types/conf.ts#L3)
+[src/types/conf.ts:1](https://github.com/ceajs/cea/blob/137f0b9/core/src/types/conf.ts#L1)
 
-## Properties
+## Variables
 
 ### log
 
-• **log**: `Signale`<`DefaultMethods`\>
+• **log**: `LogRouter` & { `notify`: () => `Promise`<`void`\> ; `object`: (`obj`: { [K: string]: `string`;  }) => `void`  }
+
+#### Defined in
+
+[src/utils/logger.ts:28](https://github.com/ceajs/cea/blob/137f0b9/core/src/utils/logger.ts#L28)
 
 ## Functions
 
@@ -158,7 +166,7 @@ Parse http response headers' cookie
 
 #### Defined in
 
-[src/utils/cookie-helper.ts:7](https://github.com/ceajs/cea/blob/08338e7/core/src/utils/cookie-helper.ts#L7)
+[src/utils/cookie-helper.ts:7](https://github.com/ceajs/cea/blob/137f0b9/core/src/utils/cookie-helper.ts#L7)
 
 ___
 
@@ -181,49 +189,43 @@ Construct a cookie object based on host
 
 #### Defined in
 
-[src/utils/cookie-helper.ts:50](https://github.com/ceajs/cea/blob/08338e7/core/src/utils/cookie-helper.ts#L50)
+[src/utils/cookie-helper.ts:50](https://github.com/ceajs/cea/blob/137f0b9/core/src/utils/cookie-helper.ts#L50)
 
 ___
 
 ### getSchoolInfos
 
-▸ **getSchoolInfos**(`users`): `Promise`<[`SchoolConf`](../modules.md#schoolconf) \| ``null``\>
+▸ **getSchoolInfos**(`__namedParameters`): `Promise`<[`SchoolConf`](../modules.md#schoolconf) \| ``null``\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `users` | [`UsersConf`](../modules.md#usersconf) |
+| `__namedParameters` | [`UsersConf`](../modules.md#usersconf) |
 
 #### Returns
 
 `Promise`<[`SchoolConf`](../modules.md#schoolconf) \| ``null``\>
 
 #### Defined in
 
-[src/conf.ts:25](https://github.com/ceajs/cea/blob/08338e7/core/src/conf.ts#L25)
+[src/conf.ts:26](https://github.com/ceajs/cea/blob/137f0b9/core/src/conf.ts#L26)
 
 ___
 
 ### handleCookie
 
-▸ **handleCookie**(`options?`): `Promise`<`void`\>
+▸ **handleCookie**(): `Promise`<`void`\>
 
 Iterate through all users: complete unified auth -> store cookie
 
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `options?` | [`HandleCookieOptions`](../interfaces/HandleCookieOptions.md) |
-
 #### Returns
 
 `Promise`<`void`\>
 
 #### Defined in
 
-[src/index.ts:33](https://github.com/ceajs/cea/blob/08338e7/core/src/index.ts#L33)
+[src/index.ts:33](https://github.com/ceajs/cea/blob/137f0b9/core/src/index.ts#L33)
 
 ___
 
@@ -237,4 +239,4 @@ ___
 
 #### Defined in
 
-[src/conf.ts:12](https://github.com/ceajs/cea/blob/08338e7/core/src/conf.ts#L12)
+[src/conf.ts:13](https://github.com/ceajs/cea/blob/137f0b9/core/src/conf.ts#L13)

docs/api/core/modules.md

@@ -43,5 +43,5 @@ cea.start()
 # 文档
 
 - 项目说明：https://github.com/ceajs/cea/tree/main/internal
-- API 文档：https://github.com/ceajs/cea/blob/main/docs/api/- internal/modules.md
+- API 文档：https://github.com/ceajs/cea/blob/main/docs/api/internal/modules.md
 - 配置文档：https://github.com/ceajs/cea

docs/api/internal/README.md

@@ -31,7 +31,7 @@
 
 #### Defined in
 
-[internal/src/index.ts:5](https://github.com/ceajs/cea/blob/08338e7/internal/src/index.ts#L5)
+[internal/src/index.ts:5](https://github.com/ceajs/cea/blob/137f0b9/internal/src/index.ts#L5)
 
 ## Methods
 
@@ -51,7 +51,7 @@
 
 #### Defined in
 
-[internal/src/index.ts:7](https://github.com/ceajs/cea/blob/08338e7/internal/src/index.ts#L7)
+[internal/src/index.ts:7](https://github.com/ceajs/cea/blob/137f0b9/internal/src/index.ts#L7)
 
 ___
 
@@ -65,4 +65,4 @@ ___
 
 #### Defined in
 
-[internal/src/index.ts:11](https://github.com/ceajs/cea/blob/08338e7/internal/src/index.ts#L11)
+[internal/src/index.ts:11](https://github.com/ceajs/cea/blob/137f0b9/internal/src/index.ts#L11)