@leaflow/sdk 0.0.0-dev.13.g732c6b7 → 0.0.0-dev.132.gf5ad077

package/README.md

@@ -1,24 +1,34 @@
 # leaflow-ts
 
-Leaflow 平台的 TypeScript SDK(`@leaflow/sdk`)。
-`gen/` 下全是产物,源在 `LeaflowNET/leaflowapis`。
+Leaflow 平台的 TypeScript SDK(`@leaflow/sdk`),由
+[leaflowapis](https://github.com/leaflowapis/leaflowapis) 生成。
 
-## 为什么和 Go 分开在两个仓库
+```
+npm i @leaflow/sdk openapi-fetch
+```
 
-**它们在同一个仓库里会抢同一个 tag 空间。** Go 的子目录模块要 `go/v1.2.3` 这种带前缀的 tag,
-npm 要 `v1.2.3`——上一版两者挤在一个仓库里,结果是 Go 那半从来没被正确发布过,而没有任何东西
-会报错(`go get` 只是拿不到)。
+当前只含类型。请求由 `openapi-fetch` 发出,路径与参数由契约约束。
 
-## 契约是一个 submodule
+```ts
+import createClient from 'openapi-fetch';
+import type { compute } from '@leaflow/sdk';
 
+const api = createClient<compute.paths>({
+    baseUrl: 'https://compute.leaflow.cloud',
+    headers: { Authorization: `Bearer ${token}` },
+});
+
+const { data, error } = await api.GET('/api/v1/instances', {
+    params: { query: { limit: 20 } },
+});
 ```
-leaflowapis/    钉在某一个 commit 上——那个指针就是「这版 SDK 出自哪版契约」的答案
-```
+
+每个操作另有 `<操作>Result` / `<操作>Body` / `<操作>Query` 三个类型别名。
+
+## 重新生成
 
 ```
-git submodule update --remote leaflowapis   # 要跟进新契约时才做
 npm run generate
 ```
 
-产物由人在本地跑完提交,CI 只验证不写回:一个会 commit 回来的流水线,在两次推送挨得近时只能靠
-重试或者强推——前者会打架,后者会丢东西。
+契约版本记在 `CONTRACTS_REF`。

package/dist/account/v1/index.d.ts

@@ -1,5 +1,9 @@
 export type { paths, components, operations, webhooks } from "./schema.js";
 import type { operations } from "./schema.js";
+/** `GET /account/v1/settings` 成功时的响应体。 */
+export type GetSettingsResult = operations["get-settings"]["responses"][200]["content"]["application/json"];
+/** `GET /account/v1/locales` 成功时的响应体。 */
+export type ListLocalesResult = operations["list-locales"]["responses"][200]["content"]["application/json"];
 /** `GET /account/v1/agreements` 成功时的响应体。 */
 export type ListAgreementsResult = operations["list-agreements"]["responses"][200]["content"]["application/json"];
 /** `GET /account/v1/me/consents` 成功时的响应体。 */
@@ -14,6 +18,10 @@ export type RegisterResult = operations["register"]["responses"][201]["content"]
 export type RegisterBody = NonNullable<operations["register"]["requestBody"]>["content"]["application/json"];
 /** `GET /account/v1/me` 成功时的响应体。 */
 export type GetAccountResult = operations["get-account"]["responses"][200]["content"]["application/json"];
+/** `PATCH /account/v1/me` 成功时的响应体。 */
+export type UpdateAccountResult = operations["update-account"]["responses"][200]["content"]["application/json"];
+/** `PATCH /account/v1/me` 的请求体。 */
+export type UpdateAccountBody = NonNullable<operations["update-account"]["requestBody"]>["content"]["application/json"];
 /** `GET /account/v1/me/identity-verification` 成功时的响应体。 */
 export type GetIdentityVerificationResult = operations["get-identity-verification"]["responses"][200]["content"]["application/json"];
 /** `POST /account/v1/me/identity-verification` 成功时的响应体。 */
@@ -24,6 +32,10 @@ export type SubmitIdentityVerificationBody = NonNullable<operations["submit-iden
 export type ListMyInvitationsResult = operations["list-my-invitations"]["responses"][200]["content"]["application/json"];
 /** `GET /account/v1/me/invitations` 的查询参数。 */
 export type ListMyInvitationsQuery = operations["list-my-invitations"]["parameters"]["query"];
+/** `GET /account/v1/invitations/by-token` 成功时的响应体。 */
+export type PreviewInvitationByTokenResult = operations["preview-invitation-by-token"]["responses"][200]["content"]["application/json"];
+/** `GET /account/v1/invitations/by-token` 的查询参数。 */
+export type PreviewInvitationByTokenQuery = operations["preview-invitation-by-token"]["parameters"]["query"];
 /** `POST /account/v1/me/invitations/accept` 成功时的响应体。 */
 export type AcceptInvitationByTokenResult = operations["accept-invitation-by-token"]["responses"][200]["content"]["application/json"];
 /** `POST /account/v1/me/invitations/accept` 的请求体。 */
@@ -38,5 +50,5 @@ export type ListProjectsQuery = operations["list-projects"]["parameters"]["query
 export type CreateProjectResult = operations["create-project"]["responses"][201]["content"]["application/json"];
 /** `POST /account/v1/projects` 的请求体。 */
 export type CreateProjectBody = NonNullable<operations["create-project"]["requestBody"]>["content"]["application/json"];
-/** `POST /account/v1/projects/{projectId}/token` 成功时的响应体。 */
-export type ExchangeProjectTokenResult = operations["exchange-project-token"]["responses"][201]["content"]["application/json"];
+/** `POST /account/v1/projects/{projectId}/scoped-tokens` 成功时的响应体。 */
+export type CreateScopedTokenResult = operations["create-scoped-token"]["responses"][201]["content"]["application/json"];