@leaflow/sdk 0.0.0-dev.101.g01ce843

package/dist/support/v1/schema.js

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export {};

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

@@ -0,0 +1,16 @@
+export type { paths, components, operations, webhooks } from "./schema.js";
+import type { operations } from "./schema.js";
+/** `GET /api/v1/tunnel/l4` 成功时的响应体。 */
+export type GetL4TunnelResult = operations["get-l4-tunnel"]["responses"][200]["content"]["application/json"];
+/** `POST /api/v1/tunnel/l4` 成功时的响应体。 */
+export type GenerateL4TunnelResult = operations["generate-l4-tunnel"]["responses"][200]["content"]["application/json"];
+/** `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` 成功时的响应体。 */
+export type RotateL4TunnelSubscriptionResult = operations["rotate-l4-tunnel-subscription"]["responses"][200]["content"]["application/json"];
+/** `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` 成功时的响应体。 */
+export type ListL4TunnelUsageSeriesResult = operations["list-l4-tunnel-usage-series"]["responses"][200]["content"]["application/json"];
+/** `GET /api/v1/tunnel/l4/usage/series` 的查询参数。 */
+export type ListL4TunnelUsageSeriesQuery = operations["list-l4-tunnel-usage-series"]["parameters"]["query"];

package/dist/tunnel/v1/index.js

@@ -0,0 +1,5 @@
+// 由 scripts/generate-ts.mjs 生成，不要手改。
+//
+// 别名把 operations[...] 那串下标换成一个名字。原始的 paths / components / operations 也
+// 一并导出：paths 是给 openapi-fetch 的 createClient<paths>() 用的。
+export {};

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

@@ -0,0 +1,401 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/api/v1/tunnel/l4": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 查看本项目的四层隧道
+         * @description 还没生成过时返回 `TUNNEL_NOT_FOUND`——首屏据此决定画「生成订阅链接」那个按钮还是画结果。
+         *
+         *     项目未获开放时返回 403 `TUNNEL_NOT_ENTITLED`，那是另一件事：控制台据此把四层隧道的入口整个收起来，而不是画那个按钮。
+         *
+         *     订阅地址、用量、配额各有自己的接口，这里不重复返回。
+         */
+        get: operations["get-l4-tunnel"];
+        put?: never;
+        /**
+         * 生成四层隧道
+         * @description **幂等**：已经有了再调一次返回同一条，不报错。按钮被点两次是安全的。
+         *
+         *     生成之后请调订阅接口取地址，本接口不返回它。
+         */
+        post: operations["generate-l4-tunnel"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/tunnel/l4/subscription": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 获取订阅地址
+         * @description **这条 URL 是凭据，等同于密码。** 拿着它就能取到这个项目的全部节点和密码，所以它只在这一个接口里出现，一次一条——不进任何列表，也不在隧道详情里。
+         *
+         *     客户端不应在用户主动请求之前调用它：这个接口的每一次调用都会被记进操作日志。
+         *
+         *     `status` 为 `preparing` 时链接**照样有效**，内容会在拉取那一刻重新派生。它只该影响页面上说什么。
+         */
+        get: operations["get-l4-tunnel-subscription"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/tunnel/l4/subscription/rotate": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * 重置订阅地址与节点密码
+         * @description **这是凭据泄露时的处置手段，会让已分发出去的每一份订阅立即失效。**
+         *
+         *     订阅 token 和节点密码同时更换，所有客户端都必须重新拉取一次订阅才能继续使用。调用前请确认这确实是想要的结果。
+         *
+         *     隧道被平台停用时无法重置（`TUNNEL_DISABLED_FOR_ROTATE`），需要先处理停用的原因。
+         *
+         *     重置后请调订阅接口取新地址，**本接口不返回它**。
+         */
+        post: operations["rotate-l4-tunnel-subscription"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/tunnel/l4/usage": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 查看本期用量
+         * @description 实时查询，不经过缓存。
+         *
+         *     判断是否超额只看 `billed_bytes`：线路可以设置倍率（如 1.5× 或 0×），`raw_bytes` 是实际传输量，两者不一定相等。`quota_bytes` 为 0 表示不限量。
+         */
+        get: operations["get-l4-tunnel-usage"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/tunnel/l4/usage/series": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 查看按天用量
+         * @description 按自然日切分。没有流量的日子不会出现在结果里（不补零），画图那一侧要自己补齐日期轴——否则一段没人用的日子会被画成一条直接连过去的线，看起来像那几天一直在匀速跑流量。
+         *
+         *     把这里的天加起来**不等于**本期用量，这是有意的：本期按计费周期切，而且「重置本期用量」只作用于本期，日汇总一行都不删。
+         */
+        get: operations["list-l4-tunnel-usage-series"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        Error: {
+            code?: string;
+            message: string;
+            meta?: {
+                [key: string]: unknown;
+            };
+            /** Format: int64 */
+            status: number;
+        };
+        SubscriptionResource: {
+            /**
+             * @description ready 表示节点已全部下发；preparing 表示仍在下发——此时链接照样可用
+             * @enum {string}
+             */
+            status: "preparing" | "ready";
+            /** Format: date-time */
+            updated_at: string;
+            /** @description 订阅地址。这是一条长期有效的凭据，等同于密码，请勿转发或截图分享 */
+            url: string;
+            /** Format: int64 */
+            version: number;
+        };
+        /** @description 当前项目那条四层隧道。它只回答一个问题：生成过没有。 */
+        TunnelResource: {
+            /** Format: date-time */
+            created_at: string;
+            /** @description 隧道当前是否可用。为 false 表示被平台停用（欠费、违规或项目停服），需要先处理停用的原因 */
+            enabled: boolean;
+            /** Format: uuid */
+            id: string;
+        };
+        UsageDayResource: {
+            /** Format: int64 */
+            billed_bytes: number;
+            /** @description YYYY-MM-DD */
+            day: string;
+            /** Format: int64 */
+            raw_bytes: number;
+        };
+        UsageResource: {
+            /**
+             * Format: int64
+             * @description 按线路倍率折算后的用量，配额比对以此为准
+             */
+            billed_bytes: number;
+            over_quota: boolean;
+            /** @description 本期计费周期的结束日（YYYY-MM-DD） */
+            period_end: string;
+            /** @description 本期计费周期的起始日（YYYY-MM-DD） */
+            period_start: string;
+            /**
+             * Format: int64
+             * @description 上游给出的真实配额，0 表示不限量
+             */
+            quota_bytes: number;
+            /**
+             * Format: date-time
+             * @description 上游判定超额的时刻；null 表示未超额
+             */
+            quota_exceeded_at: string | null;
+            /**
+             * Format: int64
+             * @description 实际传输的字节，不用于配额比对
+             */
+            raw_bytes: number;
+            /** Format: int64 */
+            upload_bytes: number;
+            /**
+             * Format: double
+             * @description 上游给出的用量百分比
+             */
+            usage_percent: number;
+        };
+        UsageSeriesResource: {
+            /**
+             * Format: int64
+             * @description 上游实际采用的天数，可能被它夹到 1–365
+             */
+            days: number;
+            points: components["schemas"]["UsageDayResource"][];
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    "get-l4-tunnel": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TunnelResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "generate-l4-tunnel": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TunnelResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "get-l4-tunnel-subscription": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SubscriptionResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "rotate-l4-tunnel-subscription": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TunnelResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "get-l4-tunnel-usage": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UsageResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "list-l4-tunnel-usage-series": {
+        parameters: {
+            query?: {
+                /** @description 取最近多少天。0 表示用上游的默认值（30）——上游只接受 1–365，超出会被它夹住 */
+                days?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UsageSeriesResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+}

package/dist/tunnel/v1/schema.js

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export {};

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@leaflow/sdk",
+  "version": "0.0.0-dev.101.g01ce843",
+  "description": "Leaflow 平台 API 的 TypeScript SDK",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/leaflowapis/leaflow-ts.git"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./account/v1": {
+      "types": "./dist/account/v1/index.d.ts",
+      "default": "./dist/account/v1/index.js"
+    },
+    "./assistant/v1": {
+      "types": "./dist/assistant/v1/index.d.ts",
+      "default": "./dist/assistant/v1/index.js"
+    },
+    "./canopy/v1": {
+      "types": "./dist/canopy/v1/index.d.ts",
+      "default": "./dist/canopy/v1/index.js"
+    },
+    "./compute/v1": {
+      "types": "./dist/compute/v1/index.d.ts",
+      "default": "./dist/compute/v1/index.js"
+    },
+    "./iam/v1": {
+      "types": "./dist/iam/v1/index.d.ts",
+      "default": "./dist/iam/v1/index.js"
+    },
+    "./monitoring/v1": {
+      "types": "./dist/monitoring/v1/index.d.ts",
+      "default": "./dist/monitoring/v1/index.js"
+    },
+    "./tunnel/v1": {
+      "types": "./dist/tunnel/v1/index.d.ts",
+      "default": "./dist/tunnel/v1/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "generate": "node scripts/generate.mjs",
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "openapi-typescript": "7.13.0",
+    "typescript": "^5.9.3",
+    "openapi-fetch": "^0.17.0",
+    "yaml": "^2.8.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "openapi-fetch": ">=0.14"
+  },
+  "peerDependenciesMeta": {
+    "openapi-fetch": {
+      "optional": true
+    }
+  }
+}