feat(rest): add wrapper client #3193
Conversation
shabaraba
requested review from
chihiro-adachi and
tasshi-me
and removed request for
a team
shabaraba
force-pushed
the
feat/add-wrapper-client
branch
from
a700b27 to
e65d208
Compare
| auth?: AuthOption; | ||
| basicAuth?: BasicAuthOption; | ||
| proxy?: Proxy; | ||
| httpsAgent?: HttpsAgent; | ||
| clientCertAuth?: ClientCertAuth; | ||
| userAgent?: string; | ||
| socketTimeout?: number; |
There was a problem hiding this comment.
この辺りは OR | AND の関係性のオプションがあれば、それを型に反映したいです。
例えば httpsAgent はいくつかのHTTP or TCPレイヤーの設定と排他になっているので、それを反映してもらうと良さそうです。
There was a problem hiding this comment.
@tasshi-me
書き方が適切か見ていただきたいのですが、proxy, httpsAgent, clientCertAuthを１つだけしか指定できないようにしました。
There was a problem hiding this comment.
あーなるほど、
単純に↓のようなunion typeにしても余剰プロパティチェックが効かないのでneverを入れてるんですね。
| {
proxy?: Proxy;
}
| {
httpsAgent?: HttpsAgent;
}
| {
certAuth?: ClientCertAuth;
}型補完が分かりにくくなるのでやはりdiscriminated unionかなーとも思いましたが、利用者が直接使うオプションなのでkindsを指定させるほうがややこしそう。
これで良さそうです！
| export type ApiTokenAuth = { | ||
| apiToken: string | string[]; | ||
| }; | ||
|
|
||
| export type PasswordAuth = { | ||
| username: string; | ||
| password: string; | ||
| }; | ||
|
|
||
| export type SessionAuth = {}; | ||
|
|
||
| export type OAuthTokenAuth = { | ||
| oAuthToken: string; | ||
| }; |
There was a problem hiding this comment.
ここは discriminated union でもいいかもしれないですが、どっちでも良さそう。
（プロパティ名で判定できているし、認証の必要情報が大きく変わることはなさそう）
There was a problem hiding this comment.
こちらはdiscriminated unionに変更しました。
shabaraba
force-pushed
the
feat/add-wrapper-client
branch
2 times, most recently
from
48485eb to
eb187e7
Compare
shabaraba
force-pushed
the
feat/add-wrapper-client
branch
from
eb187e7 to
a721a3c
Compare
| export const createClient = (clientOptions: KintoneClientOptions) => { | ||
| return _createClient<paths>(clientOptions); | ||
| }; |
There was a problem hiding this comment.
pathsが巨大すぎるので、_createClientをラップせずpathsをジェネリクスで渡さず直接コーディングすると、型が壊れてしまう。
| } & ( | ||
| | { | ||
| proxy?: Proxy; | ||
| httpsAgent?: never; | ||
| certAuth?: never; | ||
| } | ||
| | { | ||
| proxy?: never; | ||
| httpsAgent?: HttpsAgent; | ||
| certAuth?: never; | ||
| } | ||
| | { | ||
| proxy?: never; | ||
| httpsAgent?: never; | ||
| certAuth?: ClientCertAuth; | ||
| } |
There was a problem hiding this comment.
never型を指定することでどれか一つしかとれないようにした
| [key: string]: unknown; | ||
| }; | ||
|
|
||
| type KintoneMethodType = Extract<HttpMethod, "get" | "post" | "put" | "delete">; |
There was a problem hiding this comment.
Extractを使えばHttpMethodの一部であることを明示できる、多分
Why
We want to improve the development experience using rest.js.
What
createClient()to reduce the code and improve the developer experience.createClient()method similar to those of rest-api-client.api()to the client, whose interface is similar tokintone.api()of JavaScript APIHow to test
Checklist
pnpm lintandpnpm teston the root directory.