@leaflow/sdk 0.0.0-dev.11.g7f2d603 → 0.0.0-dev.111.g0e20563

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` 的请求体。 */

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

@@ -3,6 +3,52 @@
  * Do not make direct changes to the file.
  */
 export interface paths {
+    "/account/v1/settings": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 这个平台现在收不收人
+         * @description 注册页和「新建项目」按钮用它决定画什么。不需要令牌。
+         *
+         *     `registration_mode` 不是 `OPEN` 时 `POST /account/v1/register` 会答 403：`CLOSED` 是整个关着，`INVITE_ONLY` 是只收手上有项目邀请的邮箱。`project_creation_mode` 同理，`VERIFIED_ONLY` 要先过实名。
+         *
+         *     两条配额是 0 表示不限。它们只用来提前提示，真正的判定在写入那一刻。
+         */
+        get: operations["get-settings"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/account/v1/locales": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 注册页要用的国家/地区和语言清单
+         * @description 免认证：注册页在还没有账号的时候就要画出这两个下拉框。
+         *     国家名和排序都跟着 `Accept-Language` 走——一个英文用户看到的是 China 而不是「中国」， 而顺序按那种语言自己的规则（中文按拼音，英文按字母），不是按码点。头缺失时用简体中文。
+         *     清单来自 CLDR，不是我们自己维护的一份：ISO 3166 每年都改，而抄下来的那份不会跟着改。 已经退役的代码（苏联、南斯拉夫）和不是地方的代码（欧盟、联合国）都不在里面。
+         */
+        get: operations["list-locales"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/account/v1/agreements": {
         parameters: {
             query?: never;
@@ -90,7 +136,11 @@ export interface paths {
         delete?: never;
         options?: never;
         head?: never;
-        patch?: never;
+        /**
+         * 改当前账号的国家/地区和语言
+         * @description 姓名和邮箱不在这里改：它们来自身份提供方，改了会在下一次登录同步时被覆盖回去。
+         */
+        patch: operations["update-account"];
         trace?: never;
     };
     "/account/v1/me/identity-verification": {
@@ -137,6 +187,30 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/account/v1/invitations/by-token": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 看一眼这封邀请是谁发的、加入哪儿、什么角色
+         * @description 免认证，而且是有意的：点邮件里那条链接的人多半还没登录，甚至还没有账号。要他先注册再 告诉他这是谁发来的、加入哪个项目，等于让他在不知道要加入什么的情况下决定要不要注册。
+         *     它不多泄露任何东西。 这三样——项目名、邀请人、角色——邮件正文里已经写着了，而读得到 这个令牌的人就是收得到那封邮件的人。同一个令牌本来就能把持有者加进项目（见 `accept-invitation-by-token`），读一个项目名比那件事轻得多。
+         *     收件地址打了码（`t***@example.com`）。 不打码的话，这个接口就成了「拿一个令牌反查它 当初寄给了哪个地址」——而那是邮件正文里没有、持有者也未必知道的一件事。
+         *     令牌不存在、已经用过、被撤回、过期，四种情况同一个 404 和同一句话。分开报会把它变成 一个可以拿来试令牌的探针，而这个接口免认证，任何人都试得起。
+         *     它不在 `/me` 下面，隔壁那两条接受要约的在。 `/me` 的意思是「按这次请求的身份认出来 的、属于我的那些」，而这条路上没有身份——持有令牌的人未必是收件人本人。挂在 `/me` 下面会让读的人以为它认过身份，而那正是这条路唯一不做的事。
+         */
+        get: operations["preview-invitation-by-token"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/account/v1/me/invitations/accept": {
         parameters: {
             query?: never;
@@ -242,6 +316,28 @@ export interface components {
             /** Format: int64 */
             status: number;
         };
+        SettingsResource: {
+            /**
+             * Format: int64
+             * @description 一个项目最多几个成员，0 表示不限
+             */
+            max_members_per_project: number;
+            /**
+             * Format: int64
+             * @description 你最多能当几个项目的所有者，0 表示不限。已删除的项目不算在内
+             */
+            max_projects_per_user: number;
+            /**
+             * @description VERIFIED_ONLY 要求先过实名，审核中不算
+             * @enum {string}
+             */
+            project_creation_mode: "OPEN" | "VERIFIED_ONLY" | "CLOSED";
+            /**
+             * @description INVITE_ONLY 是只收手上有项目邀请的邮箱
+             * @enum {string}
+             */
+            registration_mode: "OPEN" | "INVITE_ONLY" | "CLOSED";
+        };
         AgreementResource: {
             /**
              * Format: date-time
@@ -293,6 +389,10 @@ export interface components {
             id: string;
             /** @description 来自登录信息，可能为空 */
             last_name: string;
+            /** @description ISO 3166-1 alpha-2。这两个字段是后加的，注册时才开始要求填——已经注册过的人这里 是空串，让他们在设置里补，补之前一切照常。 */
+            country?: string;
+            /** @description 为空表示没设过，那时按请求头（Accept-Language）走，两者都没有才用平台默认 */
+            locale?: string;
             pending_agreements: components["schemas"]["AgreementResource"][] | null;
             /** @enum {string} */
             status: "ACTIVE" | "SUSPENDED" | "BANNED" | "DELETING";
@@ -300,6 +400,35 @@ export interface components {
         RegisterRequestBody: {
             /** @description 当前生效的必签文件全部要在里面，版本号要和 GET /api/v1/agreements 给的一致 */
             consents: components["schemas"]["ConsentBody"][] | null;
+            /** @description ISO 3166-1 alpha-2（CN、HK、US）。必须是现实世界里真实存在的国家或地区——EU、ZZ 这类在标准里有位置但不是国家的代码会被拒。存代码不存名字：名字是本地化的，存下来 的那份只会是某一种语言的。 */
+            country: string;
+            locale: components["schemas"]["Locale"];
+        };
+        LocaleOptionsResource: {
+            countries: components["schemas"]["CountryOption"][];
+            languages: components["schemas"]["LanguageOption"][];
+        };
+        CountryOption: {
+            /** @description ISO 3166-1 alpha-2，注册时原样回传 */
+            code: string;
+            /** @description 按 Accept-Language 渲染的名字 */
+            name: string;
+        };
+        LanguageOption: {
+            code: components["schemas"]["Locale"];
+            /** @description 这种语言的自称，用它自己写（「简体中文」「繁體中文（香港）」「English」）。不跟着 Accept-Language 变——一个只看得懂繁体的人，在一个全简体的列表里找不到自己那一项。 */
+            name: string;
+        };
+        /**
+         * @description 界面和邮件用哪种语言。它和 country 是两件事，不能互相推——一个在香港的人可能读简体， 一个在美国的人可能读繁体。
+         * @enum {string}
+         */
+        Locale: "zh-Hans" | "zh-Hant-HK" | "en";
+        /** @description 两个字段都是「不传就不动」。设置页上它们是两个独立的控件，用户可能只改其中一个；做成 整体替换的话，一次只想改语言的提交会把国家清掉，而那种丢失不报错。 */
+        UpdateAccountRequestBody: {
+            /** @description 同注册时那个 country */
+            country?: string;
+            locale?: components["schemas"]["Locale"];
         };
         IdentityVerificationResource: {
             reject_reason: string;
@@ -319,6 +448,21 @@ export interface components {
             /** @description 真实姓名。敏感个人信息，加密入库，任何接口都不会再把它读出来 */
             real_name: string;
         };
+        /**
+         * @description 一封邀请在被接受之前能给出的全部信息。
+         *     它比 InvitationResource 少两样：要约 id 和完整的收件地址。id 不给是因为持有令牌不等于 这封要约列在你名下——真正列在你名下的那些走 list-my-invitations，那条是认过身份的。
+         */
+        InvitationPreviewResource: {
+            /** @description 打过码的收件地址，只够收件人认出「这是发给我的」 */
+            email_masked: string;
+            /** Format: date-time */
+            expires_at: string;
+            /** @description 邀请人的显示名，姓名都空时是他的邮箱 */
+            invited_by_name: string;
+            project_name: string;
+            /** @description 接受之后会拿到的角色，显示名 */
+            role_names: string[] | null;
+        };
         InvitationResource: {
             /** Format: date-time */
             created_at: string;
@@ -327,11 +471,21 @@ export interface components {
             expires_at: string;
             /** Format: uuid */
             id: string;
+            /** @description 发出这份要约的账号 id */
             invited_by: string;
+            /** @description 发出这份要约的人的显示名，姓名都空时是他的邮箱。它是读取那一刻的事实，不是发信时的快照 */
+            invited_by_name: string;
             /** Format: uuid */
             project_id: string;
+            /**
+             * @description 目标项目的名字。
+             *     它在这里，而这一度是刻意不给的——理由是「没接受就不是成员，而名字只有成员能读」。 那条克制在这个场景下站不住：邀请邮件正文里就写着项目名，收件人早就知道了，而一个 只显示 uuid 的邀请列表让人没法判断该不该接受。
+             */
+            project_name: string;
             /** @description 兑现时会授予的角色编码 */
             roles: string[] | null;
+            /** @description 上面那些编码的显示名，按同样的顺序。读者看的是「管理员」，不是 ADMIN */
+            role_names: string[] | null;
         };
         LengthAwarePageInvitationResource: {
             /** @description 这一页的内容 */
@@ -387,10 +541,24 @@ export interface components {
         GrantResource: {
             admin: boolean;
             owner: boolean;
-            /** @description 持有的全部自定义角色的权限并集，已去重排序 */
-            permissions: string[] | null;
             /** @description 持有的角色编码，只用于展示 */
             roles: string[] | null;
+            /** @description 他全部策略编译出来的规则。**不要自己遍历它做判定**——拿它配上自己那份权限目录交给 pkg/rbac：那里面的顺序（所有者不可被 deny、deny 优先于管理员、带资源范围的规则不 参与项目级判定）每一条都对着一种会静默放行的写法。 */
+            rules: components["schemas"]["RuleResource"][] | null;
+        };
+        ResourceRefResource: {
+            /** @description 是字符串而不是 uuid：dns 的 zone 标识是一个域名，而且它根本不在 IAM 的库里。匹配 语义是 glob，所以 *.example.com 能表达一批子域名；uuid 和域名都不含 glob 元字符， 对它们来说这就是精确相等。 */
+            id: string;
+            /** @description 形如 compute:instance、dns:zone，和权限名同一个命名空间 */
+            type: string;
+        };
+        RuleResource: {
+            /** @enum {string} */
+            effect: "allow" | "deny";
+            /** @description 支持尾部通配（compute:instance.*），通配必须带服务前缀 */
+            permissions: string[] | null;
+            /** @description 为空表示这条规则在整个项目范围内成立；非空则表示它只在这些资源上成立，而那意味着 它回答不了项目级的问题。 */
+            resources: components["schemas"]["ResourceRefResource"][] | null;
         };
         ProjectAccessResource: {
             grant: components["schemas"]["GrantResource"];
@@ -448,6 +616,64 @@ export interface components {
 }
 export type $defs = Record<string, never>;
 export interface operations {
+    "get-settings": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SettingsResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "list-locales": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LocaleOptionsResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     "list-agreements": {
         parameters: {
             query?: never;
@@ -601,6 +827,39 @@ export interface operations {
             };
         };
     };
+    "update-account": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateAccountRequestBody"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AccountResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     "get-identity-verification": {
         parameters: {
             query?: never;
@@ -697,6 +956,38 @@ export interface operations {
             };
         };
     };
+    "preview-invitation-by-token": {
+        parameters: {
+            query: {
+                /** @description 邀请链接里那串令牌 */
+                token: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InvitationPreviewResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     "accept-invitation-by-token": {
         parameters: {
             query?: never;

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

@@ -2,6 +2,8 @@ export type { paths, components, operations, webhooks } from "./schema.js";
 import type { operations } from "./schema.js";
 /** `POST /api/v1/attachments` 成功时的响应体。 */
 export type UploadAttachmentResult = operations["upload-attachment"]["responses"][201]["content"]["application/json"];
+/** `POST /api/v1/attachments` 的查询参数。 */
+export type UploadAttachmentQuery = operations["upload-attachment"]["parameters"]["query"];
 /** `GET /api/v1/bindings` 成功时的响应体。 */
 export type ListBindingsResult = operations["list-bindings"]["responses"][200]["content"]["application/json"];
 /** `GET /api/v1/bindings` 的查询参数。 */
@@ -46,8 +48,34 @@ export type GetWeixinLoginResult = operations["get-weixin-login"]["responses"][2
 export type SubmitWeixinVerifyCodeResult = operations["submit-weixin-verify-code"]["responses"][200]["content"]["application/json"];
 /** `POST /api/v1/weixin-logins/{login}/verify-code` 的请求体。 */
 export type SubmitWeixinVerifyCodeBody = NonNullable<operations["submit-weixin-verify-code"]["requestBody"]>["content"]["application/json"];
-/** `GET /api/v1/models` 成功时的响应体。 */
-export type ListModelsResult = operations["list-models"]["responses"][200]["content"]["application/json"];
+/** `POST /api/v1/dynamic-calls/{call}/result` 的请求体。 */
+export type SubmitDynamicCallResultBody = NonNullable<operations["submit-dynamic-call-result"]["requestBody"]>["content"]["application/json"];
+/** `GET /api/v1/folders` 成功时的响应体。 */
+export type ListFoldersResult = operations["list-folders"]["responses"][200]["content"]["application/json"];
+/** `POST /api/v1/folders` 成功时的响应体。 */
+export type CreateFolderResult = operations["create-folder"]["responses"][201]["content"]["application/json"];
+/** `POST /api/v1/folders` 的请求体。 */
+export type CreateFolderBody = NonNullable<operations["create-folder"]["requestBody"]>["content"]["application/json"];
+/** `GET /api/v1/folders/{folder}` 成功时的响应体。 */
+export type GetFolderResult = operations["get-folder"]["responses"][200]["content"]["application/json"];
+/** `PATCH /api/v1/folders/{folder}` 成功时的响应体。 */
+export type UpdateFolderResult = operations["update-folder"]["responses"][200]["content"]["application/json"];
+/** `PATCH /api/v1/folders/{folder}` 的请求体。 */
+export type UpdateFolderBody = NonNullable<operations["update-folder"]["requestBody"]>["content"]["application/json"];
+/** `GET /api/v1/memories` 成功时的响应体。 */
+export type ListMemoriesResult = operations["list-memories"]["responses"][200]["content"]["application/json"];
+/** `GET /api/v1/skills` 成功时的响应体。 */
+export type ListSkillsResult = operations["list-skills"]["responses"][200]["content"]["application/json"];
+/** `POST /api/v1/skills` 成功时的响应体。 */
+export type PutSkillResult = operations["put-skill"]["responses"][200]["content"]["application/json"];
+/** `POST /api/v1/skills` 的请求体。 */
+export type PutSkillBody = NonNullable<operations["put-skill"]["requestBody"]>["content"]["application/json"];
+/** `GET /api/v1/skills/{skill}` 成功时的响应体。 */
+export type GetSkillResult = operations["get-skill"]["responses"][200]["content"]["application/json"];
+/** `PATCH /api/v1/skills/{skill}` 成功时的响应体。 */
+export type SetSkillEnabledResult = operations["set-skill-enabled"]["responses"][200]["content"]["application/json"];
+/** `PATCH /api/v1/skills/{skill}` 的请求体。 */
+export type SetSkillEnabledBody = NonNullable<operations["set-skill-enabled"]["requestBody"]>["content"]["application/json"];
 /** `GET /api/v1/threads` 成功时的响应体。 */
 export type ListThreadsResult = operations["list-threads"]["responses"][200]["content"]["application/json"];
 /** `GET /api/v1/threads` 的查询参数。 */