@leaflow/sdk 0.54.4 → 0.56.0

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

@@ -1,50 +1,51 @@
 export type { paths, components, operations, webhooks } from "./schema.js";
+export { client } from "./client.js";
 import type { operations } from "./schema.js";
-/** `GET /api/v1/notices` 成功时的响应体。 */
+/** The success response body of `GET /api/v1/notices`. */
 export type ListNoticesResult = operations["list-notices"]["responses"][200]["content"]["application/json"];
-/** `GET /api/v1/tickets` 成功时的响应体。 */
+/** The success response body of `GET /api/v1/tickets`. */
 export type ListTicketsResult = operations["list-tickets"]["responses"][200]["content"]["application/json"];
-/** `GET /api/v1/tickets` 的查询参数。 */
+/** The query parameters of `GET /api/v1/tickets`. */
 export type ListTicketsQuery = operations["list-tickets"]["parameters"]["query"];
-/** `POST /api/v1/tickets` 成功时的响应体。 */
+/** The success response body of `POST /api/v1/tickets`. */
 export type CreateTicketResult = operations["create-ticket"]["responses"][201]["content"]["application/json"];
-/** `POST /api/v1/tickets` 的请求体。 */
+/** The request body of `POST /api/v1/tickets`. */
 export type CreateTicketBody = NonNullable<operations["create-ticket"]["requestBody"]>["content"]["application/json"];
-/** `GET /api/v1/tickets/{ticketId}` 成功时的响应体。 */
+/** The success response body of `GET /api/v1/tickets/{ticketId}`. */
 export type GetTicketResult = operations["get-ticket"]["responses"][200]["content"]["application/json"];
-/** `POST /api/v1/tickets/{ticketId}/close` 成功时的响应体。 */
+/** The success response body of `POST /api/v1/tickets/{ticketId}/close`. */
 export type CloseTicketResult = operations["close-ticket"]["responses"][200]["content"]["application/json"];
-/** `GET /api/v1/tickets/{ticketId}/messages` 成功时的响应体。 */
+/** The success response body of `GET /api/v1/tickets/{ticketId}/messages`. */
 export type ListTicketMessagesResult = operations["list-ticket-messages"]["responses"][200]["content"]["application/json"];
-/** `GET /api/v1/tickets/{ticketId}/messages` 的查询参数。 */
+/** The query parameters of `GET /api/v1/tickets/{ticketId}/messages`. */
 export type ListTicketMessagesQuery = operations["list-ticket-messages"]["parameters"]["query"];
-/** `POST /api/v1/tickets/{ticketId}/messages` 成功时的响应体。 */
+/** The success response body of `POST /api/v1/tickets/{ticketId}/messages`. */
 export type CreateTicketMessageResult = operations["create-ticket-message"]["responses"][201]["content"]["application/json"];
-/** `POST /api/v1/tickets/{ticketId}/messages` 的请求体。 */
+/** The request body of `POST /api/v1/tickets/{ticketId}/messages`. */
 export type CreateTicketMessageBody = NonNullable<operations["create-ticket-message"]["requestBody"]>["content"]["application/json"];
-/** `GET /api/v1/tickets/{ticketId}/satisfaction` 成功时的响应体。 */
+/** The success response body of `GET /api/v1/tickets/{ticketId}/satisfaction`. */
 export type GetTicketSatisfactionResult = operations["get-ticket-satisfaction"]["responses"][200]["content"]["application/json"];
-/** `POST /api/v1/tickets/{ticketId}/satisfaction` 成功时的响应体。 */
+/** The success response body of `POST /api/v1/tickets/{ticketId}/satisfaction`. */
 export type CreateTicketSatisfactionResult = operations["create-ticket-satisfaction"]["responses"][201]["content"]["application/json"];
-/** `POST /api/v1/tickets/{ticketId}/satisfaction` 的请求体。 */
+/** The request body of `POST /api/v1/tickets/{ticketId}/satisfaction`. */
 export type CreateTicketSatisfactionBody = NonNullable<operations["create-ticket-satisfaction"]["requestBody"]>["content"]["application/json"];
-/** `GET /api/v1/ticket-categories` 成功时的响应体。 */
+/** The success response body of `GET /api/v1/ticket-categories`. */
 export type ListTicketCategoriesResult = operations["list-ticket-categories"]["responses"][200]["content"]["application/json"];
-/** `GET /api/v1/ticket-categories` 的查询参数。 */
+/** The query parameters of `GET /api/v1/ticket-categories`. */
 export type ListTicketCategoriesQuery = operations["list-ticket-categories"]["parameters"]["query"];
-/** `POST /api/v1/attachments` 成功时的响应体。 */
+/** The success response body of `POST /api/v1/attachments`. */
 export type UploadAttachmentResult = operations["upload-attachment"]["responses"][201]["content"]["application/json"];
-/** `POST /api/v1/attachments` 的查询参数。 */
+/** The query parameters of `POST /api/v1/attachments`. */
 export type UploadAttachmentQuery = operations["upload-attachment"]["parameters"]["query"];
-/** `GET /api/v1/attachments/{attachmentId}/content` 的查询参数。 */
+/** The query parameters of `GET /api/v1/attachments/{attachmentId}/content`. */
 export type DownloadAttachmentQuery = operations["download-attachment"]["parameters"]["query"];
-/** `GET /api/v1/maintenances` 成功时的响应体。 */
+/** The success response body of `GET /api/v1/maintenances`. */
 export type ListMaintenancesResult = operations["list-maintenances"]["responses"][200]["content"]["application/json"];
-/** `GET /api/v1/maintenances` 的查询参数。 */
+/** The query parameters of `GET /api/v1/maintenances`. */
 export type ListMaintenancesQuery = operations["list-maintenances"]["parameters"]["query"];
-/** `GET /api/v1/maintenances/{maintenanceId}` 成功时的响应体。 */
+/** The success response body of `GET /api/v1/maintenances/{maintenanceId}`. */
 export type GetMaintenanceResult = operations["get-maintenance"]["responses"][200]["content"]["application/json"];
-/** `GET /api/v1/maintenances/{maintenanceId}/timeline` 成功时的响应体。 */
+/** The success response body of `GET /api/v1/maintenances/{maintenanceId}/timeline`. */
 export type ListMaintenanceTimelineResult = operations["list-maintenance-timeline"]["responses"][200]["content"]["application/json"];
-/** `GET /api/v1/maintenances/{maintenanceId}/timeline` 的查询参数。 */
+/** The query parameters of `GET /api/v1/maintenances/{maintenanceId}/timeline`. */
 export type ListMaintenanceTimelineQuery = operations["list-maintenance-timeline"]["parameters"]["query"];

package/dist/support/v1/index.js

@@ -1,5 +1,5 @@
-// 由 scripts/generate-ts.mjs 生成，不要手改。
+// Code generated by scripts/generate.mjs. DO NOT EDIT.
 //
-// 别名把 operations[...] 那串下标换成一个名字。原始的 paths / components / operations 也
-// 一并导出：paths 是给 openapi-fetch 的 createClient<paths>() 用的。
-export {};
+// The aliases replace the operations[...] subscript chain with a name. The raw paths /
+// components / operations are exported as well: paths is what createClient<paths>() takes.
+export { client } from "./client.js";

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

@@ -298,6 +298,10 @@ export interface components {
         Error: {
             code?: string;
             message: string;
+            /**
+             * @description What a given `code` carries alongside the message. The keys depend on the code,
+             *     and a client that does not recognise one ignores it.
+             */
             meta?: {
                 [key: string]: unknown;
             };

package/dist/tunnel/v1/client.d.ts

@@ -0,0 +1,4 @@
+import { type ClientOptions } from "openapi-fetch";
+import type { paths } from "./schema.js";
+/** A client for the tunnel service. Pass baseUrl to override the address. */
+export declare function client(options?: ClientOptions): import("openapi-fetch").Client<paths, `${string}/${string}`>;

package/dist/tunnel/v1/client.js

@@ -0,0 +1,7 @@
+// Code generated from the contract's servers[0]. DO NOT EDIT.
+import createClient, {} from "openapi-fetch";
+const defaultBaseUrl = "https://tunnel.leaflow.cloud";
+/** A client for the tunnel service. Pass baseUrl to override the address. */
+export function client(options = {}) {
+    return createClient({ baseUrl: defaultBaseUrl, ...options });
+}

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

@@ -1,16 +1,17 @@
 export type { paths, components, operations, webhooks } from "./schema.js";
+export { client } from "./client.js";
 import type { operations } from "./schema.js";
-/** `GET /api/v1/tunnel/l4` 成功时的响应体。 */
+/** The success response body of `GET /api/v1/tunnel/l4`. */
 export type GetL4TunnelResult = operations["get-l4-tunnel"]["responses"][200]["content"]["application/json"];
-/** `POST /api/v1/tunnel/l4` 成功时的响应体。 */
+/** The success response body of `POST /api/v1/tunnel/l4`. */
 export type GenerateL4TunnelResult = operations["generate-l4-tunnel"]["responses"][200]["content"]["application/json"];
-/** `GET /api/v1/tunnel/l4/subscription` 成功时的响应体。 */
+/** The success response body of `GET /api/v1/tunnel/l4/subscription`. */
 export type GetL4TunnelSubscriptionResult = operations["get-l4-tunnel-subscription"]["responses"][200]["content"]["application/json"];
-/** `POST /api/v1/tunnel/l4/subscription/rotate` 成功时的响应体。 */
+/** The success response body of `POST /api/v1/tunnel/l4/subscription/rotate`. */
 export type RotateL4TunnelSubscriptionResult = operations["rotate-l4-tunnel-subscription"]["responses"][200]["content"]["application/json"];
-/** `GET /api/v1/tunnel/l4/usage` 成功时的响应体。 */
+/** The success response body of `GET /api/v1/tunnel/l4/usage`. */
 export type GetL4TunnelUsageResult = operations["get-l4-tunnel-usage"]["responses"][200]["content"]["application/json"];
-/** `GET /api/v1/tunnel/l4/usage/series` 成功时的响应体。 */
+/** The success response body of `GET /api/v1/tunnel/l4/usage/series`. */
 export type ListL4TunnelUsageSeriesResult = operations["list-l4-tunnel-usage-series"]["responses"][200]["content"]["application/json"];
-/** `GET /api/v1/tunnel/l4/usage/series` 的查询参数。 */
+/** The query parameters of `GET /api/v1/tunnel/l4/usage/series`. */
 export type ListL4TunnelUsageSeriesQuery = operations["list-l4-tunnel-usage-series"]["parameters"]["query"];

package/dist/tunnel/v1/index.js

@@ -1,5 +1,5 @@
-// 由 scripts/generate-ts.mjs 生成，不要手改。
+// Code generated by scripts/generate.mjs. DO NOT EDIT.
 //
-// 别名把 operations[...] 那串下标换成一个名字。原始的 paths / components / operations 也
-// 一并导出：paths 是给 openapi-fetch 的 createClient<paths>() 用的。
-export {};
+// The aliases replace the operations[...] subscript chain with a name. The raw paths /
+// components / operations are exported as well: paths is what createClient<paths>() takes.
+export { client } from "./client.js";

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

@@ -11,20 +11,20 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * 查看本项目的四层隧道
-         * @description 还没生成过时返回 `TUNNEL_NOT_FOUND`——首屏据此决定画「生成订阅链接」那个按钮还是画结果。
+         * Get the layer 4 tunnel of the current project
+         * @description `TUNNEL_NOT_FOUND` means no tunnel has been generated yet.
          *
-         *     项目未获开放时返回 403 `TUNNEL_NOT_ENTITLED`，那是另一件事：控制台据此把四层隧道的入口整个收起来，而不是画那个按钮。
+         *     403 `TUNNEL_NOT_ENTITLED` states something else: the project has not been entitled to layer 4 at all.
          *
-         *     订阅地址、用量、配额各有自己的接口，这里不重复返回。
+         *     The subscription address, the usage and the quota each have their own endpoint and are not repeated here.
          */
         get: operations["get-l4-tunnel"];
         put?: never;
         /**
-         * 生成四层隧道
-         * @description **幂等**：已经有了再调一次返回同一条，不报错。按钮被点两次是安全的。
+         * Generate the layer 4 tunnel
+         * @description **Idempotent**: calling it again returns the existing tunnel rather than an error.
          *
-         *     生成之后请调订阅接口取地址，本接口不返回它。
+         *     Read the address from the subscription endpoint afterwards; it is not returned here.
          */
         post: operations["generate-l4-tunnel"];
         delete?: never;
@@ -41,12 +41,12 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * 获取订阅地址
-         * @description **这条 URL 是凭据，等同于密码。** 拿着它就能取到这个项目的全部节点和密码，所以它只在这一个接口里出现，一次一条——不进任何列表，也不在隧道详情里。
+         * Get the subscription address
+         * @description **This URL is a credential, equivalent to a password.** It yields every node of the project along with their passwords. It is returned here alone, and appears neither in the tunnel itself nor in any list.
          *
-         *     客户端不应在用户主动请求之前调用它：这个接口的每一次调用都会被记进操作日志。
+         *     Do not call this endpoint before the user asks for the address.
          *
-         *     `status` 为 `preparing` 时链接**照样有效**，内容会在拉取那一刻重新派生。它只该影响页面上说什么。
+         *     A `status` of `preparing` leaves the link usable; its contents are derived at the moment it is fetched.
          */
         get: operations["get-l4-tunnel-subscription"];
         put?: never;
@@ -67,14 +67,14 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * 重置订阅地址与节点密码
-         * @description **这是凭据泄露时的处置手段，会让已分发出去的每一份订阅立即失效。**
+         * Rotate the subscription address and the node passwords
+         * @description **This is the remedy for an exposed credential, and every subscription already distributed stops working at once.**
          *
-         *     订阅 token 和节点密码同时更换，所有客户端都必须重新拉取一次订阅才能继续使用。调用前请确认这确实是想要的结果。
+         *     The subscription token and the node passwords are replaced together, so every client has to fetch the subscription again before it can carry on. Confirm that this is the intended outcome before calling.
          *
-         *     隧道被平台停用时无法重置（`TUNNEL_DISABLED_FOR_ROTATE`），需要先处理停用的原因。
+         *     A tunnel disabled by the platform cannot be rotated (`TUNNEL_DISABLED_FOR_ROTATE`); resolve the cause first.
          *
-         *     重置后请调订阅接口取新地址，**本接口不返回它**。
+         *     Read the new address from the subscription endpoint afterwards; **it is not returned here**.
          */
         post: operations["rotate-l4-tunnel-subscription"];
         delete?: never;
@@ -91,10 +91,10 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * 查看本期用量
-         * @description 实时查询，不经过缓存。
+         * Get the usage of the current period
+         * @description Read live.
          *
-         *     判断是否超额只看 `billed_bytes`：线路可以设置倍率（如 1.5× 或 0×），`raw_bytes` 是实际传输量，两者不一定相等。`quota_bytes` 为 0 表示不限量。
+         *     Only `billed_bytes` decides whether the quota is exceeded: a route may carry a multiplier such as 1.5× or 0×, so `raw_bytes`, the volume actually transferred, need not equal it. A `quota_bytes` of 0 means unlimited.
          */
         get: operations["get-l4-tunnel-usage"];
         put?: never;
@@ -113,10 +113,10 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * 查看按天用量
-         * @description 按自然日切分。没有流量的日子不会出现在结果里（不补零），画图那一侧要自己补齐日期轴——否则一段没人用的日子会被画成一条直接连过去的线，看起来像那几天一直在匀速跑流量。
+         * Get daily usage
+         * @description Cut by calendar day. A day carrying no traffic is absent rather than zero, so a chart has to fill the date axis itself.
          *
-         *     把这里的天加起来**不等于**本期用量，这是有意的：本期按计费周期切，而且「重置本期用量」只作用于本期，日汇总一行都不删。
+         *     These days do not sum to the usage of the current period, which is cut by billing period. Resetting the usage of the current period leaves every daily total in place.
          */
         get: operations["list-l4-tunnel-usage-series"];
         put?: never;
@@ -134,6 +134,10 @@ export interface components {
         Error: {
             code?: string;
             message: string;
+            /**
+             * @description What a given `code` carries alongside the message. The keys depend on the code,
+             *     and a client that does not recognise one ignores it.
+             */
             meta?: {
                 [key: string]: unknown;
             };
@@ -142,22 +146,22 @@ export interface components {
         };
         SubscriptionResource: {
             /**
-             * @description ready 表示节点已全部下发；preparing 表示仍在下发——此时链接照样可用
+             * @description ready means every node has been distributed; preparing means distribution is still under way, and the link works either way
              * @enum {string}
              */
             status: "preparing" | "ready";
             /** Format: date-time */
             updated_at: string;
-            /** @description 订阅地址。这是一条长期有效的凭据，等同于密码，请勿转发或截图分享 */
+            /** @description The subscription address. It is a long-lived credential equivalent to a password; do not forward it or share a screenshot of it */
             url: string;
             /** Format: int64 */
             version: number;
         };
-        /** @description 当前项目那条四层隧道。它只回答一个问题：生成过没有。 */
+        /** @description The layer 4 tunnel of the current project. It answers a single question — whether the tunnel has been generated */
         TunnelResource: {
             /** Format: date-time */
             created_at: string;
-            /** @description 隧道当前是否可用。为 false 表示被平台停用（欠费、违规或项目停服），需要先处理停用的原因 */
+            /** @description Whether the tunnel is currently usable. false means the platform has disabled it — for an unpaid balance, a violation, or a suspended project — and the cause has to be resolved first */
             enabled: boolean;
             /** Format: uuid */
             id: string;
@@ -173,41 +177,41 @@ export interface components {
         UsageResource: {
             /**
              * Format: int64
-             * @description 按线路倍率折算后的用量，配额比对以此为准
+             * @description Usage after the multiplier of each route has been applied. Quota is measured against this value
              */
             billed_bytes: number;
             over_quota: boolean;
-            /** @description 本期计费周期的结束日（YYYY-MM-DD） */
+            /** @description Last day of the current billing period (YYYY-MM-DD) */
             period_end: string;
-            /** @description 本期计费周期的起始日（YYYY-MM-DD） */
+            /** @description First day of the current billing period (YYYY-MM-DD) */
             period_start: string;
             /**
              * Format: int64
-             * @description 上游给出的真实配额，0 表示不限量
+             * @description The quota in force; 0 means unlimited
              */
             quota_bytes: number;
             /**
              * Format: date-time
-             * @description 上游判定超额的时刻；null 表示未超额
+             * @description When the quota was found to be exceeded; null while it has not been
              */
             quota_exceeded_at: string | null;
             /**
              * Format: int64
-             * @description 实际传输的字节，不用于配额比对
+             * @description Bytes actually transferred. Quota is not measured against this value
              */
             raw_bytes: number;
             /** Format: int64 */
             upload_bytes: number;
             /**
              * Format: double
-             * @description 上游给出的用量百分比
+             * @description Usage as a percentage of the quota
              */
             usage_percent: number;
         };
         UsageSeriesResource: {
             /**
              * Format: int64
-             * @description 上游实际采用的天数，可能被它夹到 1–365
+             * @description The number of days actually covered, which may have been clamped to the range 1–365
              */
             days: number;
             points: components["schemas"]["UsageDayResource"][];
@@ -369,7 +373,7 @@ export interface operations {
     "list-l4-tunnel-usage-series": {
         parameters: {
             query?: {
-                /** @description 取最近多少天。0 表示用上游的默认值（30）——上游只接受 1–365，超出会被它夹住 */
+                /** @description How many days to cover. 0 requests the default of 30; the range accepted is 1–365, and a larger value is clamped to it */
                 days?: number;
             };
             header?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leaflow/sdk",
-  "version": "0.54.4",
+  "version": "0.56.0",
   "description": "Leaflow 平台 API 的 TypeScript SDK",
   "license": "MIT",
   "repository": {
@@ -52,19 +52,21 @@
     "generate": "node scripts/generate.mjs",
     "build": "tsc -p tsconfig.build.json",
     "typecheck": "tsc -p tsconfig.json --noEmit",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "format:check": "prettier --check gen scripts"
   },
   "devDependencies": {
+    "openapi-fetch": "^0.17.0",
     "openapi-typescript": "7.13.0",
+    "prettier": "^3.6.2",
     "typescript": "^5.9.3",
-    "openapi-fetch": "^0.17.0",
     "yaml": "^2.8.1"
   },
   "publishConfig": {
     "access": "public"
   },
   "peerDependencies": {
-    "openapi-fetch": ">=0.14"
+    "openapi-fetch": "^0.17.0"
   },
   "peerDependenciesMeta": {
     "openapi-fetch": {