@djvlc/openapi-user-client 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,105 @@
+import { ApiResponse, PageResolveResult, ActionExecuteRequest, ActionExecuteResponse, DataQueryRequest, DataQueryResponse } from '@djvlc/contracts-types';
+
+/**
+ * @djvlc/openapi-user-client - User API 客户端
+ *
+ * 自动从 OpenAPI 规范生成，提供类型安全的 User API 访问
+ * 用于 Runtime 访问后端服务
+ *
+ * @packageDocumentation
+ */
+
+interface UserClientConfig {
+    /** API 基础 URL */
+    baseUrl: string;
+    /** 用户 Token */
+    token?: string;
+    /** 设备 ID */
+    deviceId?: string;
+    /** 渠道 */
+    channel?: string;
+    /** 请求超时（毫秒） */
+    timeout?: number;
+    /** 自定义请求头 */
+    headers?: Record<string, string>;
+    /** 请求拦截器 */
+    onRequest?: (config: RequestInit) => RequestInit;
+    /** 响应拦截器 */
+    onResponse?: <T>(response: ApiResponse<T>) => ApiResponse<T>;
+    /** 错误处理 */
+    onError?: (error: Error) => void;
+}
+/** 页面解析请求 */
+interface ResolvePageRequest {
+    pageUid: string;
+    channel?: string;
+    uid?: string;
+    deviceId?: string;
+    previewToken?: string;
+}
+/**
+ * User API 客户端类
+ * 用于 Runtime 访问后端服务
+ */
+declare class UserApiClient {
+    private config;
+    constructor(config: UserClientConfig);
+    /**
+     * 获取通用请求头
+     */
+    private getCommonHeaders;
+    /**
+     * 发送请求
+     */
+    private request;
+    /**
+     * 解析页面
+     * GET /api/page/resolve
+     */
+    resolvePage(request: ResolvePageRequest): Promise<PageResolveResult>;
+    /**
+     * 执行动作
+     * POST /api/actions/execute
+     */
+    executeAction<T = unknown>(request: ActionExecuteRequest): Promise<ActionExecuteResponse<T>>;
+    /**
+     * 快捷方法：领取
+     */
+    claim(activityId: string, params?: Record<string, unknown>): Promise<ActionExecuteResponse>;
+    /**
+     * 快捷方法：签到
+     */
+    signin(activityId: string): Promise<ActionExecuteResponse>;
+    /**
+     * 查询数据
+     * POST /api/data/query
+     */
+    queryData<T = unknown>(request: DataQueryRequest): Promise<DataQueryResponse<T>>;
+    /**
+     * 快捷方法：查询数据
+     */
+    query<T = unknown>(queryVersionId: string, params?: Record<string, unknown>): Promise<T | undefined>;
+    /**
+     * 上报埋点
+     * POST /api/track
+     */
+    track(events: Array<{
+        eventName: string;
+        params?: Record<string, unknown>;
+        timestamp?: number;
+    }>): Promise<void>;
+    /**
+     * 健康检查
+     * GET /api/health
+     */
+    health(): Promise<{
+        status: string;
+        version: string;
+    }>;
+}
+/**
+ * 创建 User API 客户端实例
+ */
+declare function createUserClient(config: UserClientConfig): UserApiClient;
+
+export { type ResolvePageRequest, UserApiClient, type UserClientConfig, createUserClient, UserApiClient as default };

package/dist/index.d.ts

@@ -0,0 +1,105 @@
+import { ApiResponse, PageResolveResult, ActionExecuteRequest, ActionExecuteResponse, DataQueryRequest, DataQueryResponse } from '@djvlc/contracts-types';
+
+/**
+ * @djvlc/openapi-user-client - User API 客户端
+ *
+ * 自动从 OpenAPI 规范生成，提供类型安全的 User API 访问
+ * 用于 Runtime 访问后端服务
+ *
+ * @packageDocumentation
+ */
+
+interface UserClientConfig {
+    /** API 基础 URL */
+    baseUrl: string;
+    /** 用户 Token */
+    token?: string;
+    /** 设备 ID */
+    deviceId?: string;
+    /** 渠道 */
+    channel?: string;
+    /** 请求超时（毫秒） */
+    timeout?: number;
+    /** 自定义请求头 */
+    headers?: Record<string, string>;
+    /** 请求拦截器 */
+    onRequest?: (config: RequestInit) => RequestInit;
+    /** 响应拦截器 */
+    onResponse?: <T>(response: ApiResponse<T>) => ApiResponse<T>;
+    /** 错误处理 */
+    onError?: (error: Error) => void;
+}
+/** 页面解析请求 */
+interface ResolvePageRequest {
+    pageUid: string;
+    channel?: string;
+    uid?: string;
+    deviceId?: string;
+    previewToken?: string;
+}
+/**
+ * User API 客户端类
+ * 用于 Runtime 访问后端服务
+ */
+declare class UserApiClient {
+    private config;
+    constructor(config: UserClientConfig);
+    /**
+     * 获取通用请求头
+     */
+    private getCommonHeaders;
+    /**
+     * 发送请求
+     */
+    private request;
+    /**
+     * 解析页面
+     * GET /api/page/resolve
+     */
+    resolvePage(request: ResolvePageRequest): Promise<PageResolveResult>;
+    /**
+     * 执行动作
+     * POST /api/actions/execute
+     */
+    executeAction<T = unknown>(request: ActionExecuteRequest): Promise<ActionExecuteResponse<T>>;
+    /**
+     * 快捷方法：领取
+     */
+    claim(activityId: string, params?: Record<string, unknown>): Promise<ActionExecuteResponse>;
+    /**
+     * 快捷方法：签到
+     */
+    signin(activityId: string): Promise<ActionExecuteResponse>;
+    /**
+     * 查询数据
+     * POST /api/data/query
+     */
+    queryData<T = unknown>(request: DataQueryRequest): Promise<DataQueryResponse<T>>;
+    /**
+     * 快捷方法：查询数据
+     */
+    query<T = unknown>(queryVersionId: string, params?: Record<string, unknown>): Promise<T | undefined>;
+    /**
+     * 上报埋点
+     * POST /api/track
+     */
+    track(events: Array<{
+        eventName: string;
+        params?: Record<string, unknown>;
+        timestamp?: number;
+    }>): Promise<void>;
+    /**
+     * 健康检查
+     * GET /api/health
+     */
+    health(): Promise<{
+        status: string;
+        version: string;
+    }>;
+}
+/**
+ * 创建 User API 客户端实例
+ */
+declare function createUserClient(config: UserClientConfig): UserApiClient;
+
+export { type ResolvePageRequest, UserApiClient, type UserClientConfig, createUserClient, UserApiClient as default };

package/dist/index.js

@@ -0,0 +1,204 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  UserApiClient: () => UserApiClient,
+  createUserClient: () => createUserClient,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var UserApiClient = class {
+  constructor(config) {
+    this.config = {
+      timeout: 1e4,
+      ...config
+    };
+  }
+  /**
+   * 获取通用请求头
+   */
+  getCommonHeaders() {
+    const headers = {
+      "Content-Type": "application/json",
+      ...this.config.headers
+    };
+    if (this.config.token) {
+      headers["Authorization"] = `Bearer ${this.config.token}`;
+    }
+    if (this.config.deviceId) {
+      headers["x-device-id"] = this.config.deviceId;
+    }
+    if (this.config.channel) {
+      headers["x-channel"] = this.config.channel;
+    }
+    return headers;
+  }
+  /**
+   * 发送请求
+   */
+  async request(method, path, options) {
+    let url = `${this.config.baseUrl}${path}`;
+    if (options?.params) {
+      const searchParams = new URLSearchParams();
+      Object.entries(options.params).forEach(([key, value]) => {
+        if (value !== void 0) {
+          searchParams.append(key, value);
+        }
+      });
+      const queryString = searchParams.toString();
+      if (queryString) {
+        url += `?${queryString}`;
+      }
+    }
+    let requestConfig = {
+      method,
+      headers: {
+        ...this.getCommonHeaders(),
+        ...options?.headers
+      },
+      body: options?.body ? JSON.stringify(options.body) : void 0
+    };
+    if (this.config.onRequest) {
+      requestConfig = this.config.onRequest(requestConfig);
+    }
+    try {
+      const controller = new AbortController();
+      const timeoutId = setTimeout(() => controller.abort(), this.config.timeout);
+      const response = await fetch(url, {
+        ...requestConfig,
+        signal: controller.signal
+      });
+      clearTimeout(timeoutId);
+      let result = await response.json();
+      if (this.config.onResponse) {
+        result = this.config.onResponse(result);
+      }
+      if (!result.success) {
+        throw new Error(result.message || "Request failed");
+      }
+      return result.data;
+    } catch (error) {
+      if (this.config.onError) {
+        this.config.onError(error);
+      }
+      throw error;
+    }
+  }
+  // ==================== 页面解析 ====================
+  /**
+   * 解析页面
+   * GET /api/page/resolve
+   */
+  async resolvePage(request) {
+    return this.request("GET", "/api/page/resolve", {
+      params: {
+        pageUid: request.pageUid,
+        channel: request.channel,
+        uid: request.uid,
+        deviceId: request.deviceId,
+        previewToken: request.previewToken
+      }
+    });
+  }
+  // ==================== Action Gateway ====================
+  /**
+   * 执行动作
+   * POST /api/actions/execute
+   */
+  async executeAction(request) {
+    return this.request("POST", "/api/actions/execute", {
+      body: request
+    });
+  }
+  /**
+   * 快捷方法：领取
+   */
+  async claim(activityId, params) {
+    return this.executeAction({
+      actionType: "claim",
+      params: { activityId, ...params },
+      context: {
+        deviceId: this.config.deviceId,
+        channel: this.config.channel
+      }
+    });
+  }
+  /**
+   * 快捷方法：签到
+   */
+  async signin(activityId) {
+    return this.executeAction({
+      actionType: "signin",
+      params: { activityId },
+      context: {
+        deviceId: this.config.deviceId,
+        channel: this.config.channel
+      }
+    });
+  }
+  // ==================== Data Proxy ====================
+  /**
+   * 查询数据
+   * POST /api/data/query
+   */
+  async queryData(request) {
+    return this.request("POST", "/api/data/query", {
+      body: request
+    });
+  }
+  /**
+   * 快捷方法：查询数据
+   */
+  async query(queryVersionId, params) {
+    const response = await this.queryData({
+      queryVersionId,
+      params: params || {}
+    });
+    return response.data;
+  }
+  // ==================== 埋点 ====================
+  /**
+   * 上报埋点
+   * POST /api/track
+   */
+  async track(events) {
+    await this.request("POST", "/api/track", {
+      body: { events }
+    });
+  }
+  // ==================== 健康检查 ====================
+  /**
+   * 健康检查
+   * GET /api/health
+   */
+  async health() {
+    return this.request("GET", "/api/health");
+  }
+};
+function createUserClient(config) {
+  return new UserApiClient(config);
+}
+var index_default = UserApiClient;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  UserApiClient,
+  createUserClient
+});

package/dist/index.mjs

@@ -0,0 +1,178 @@
+// src/index.ts
+var UserApiClient = class {
+  constructor(config) {
+    this.config = {
+      timeout: 1e4,
+      ...config
+    };
+  }
+  /**
+   * 获取通用请求头
+   */
+  getCommonHeaders() {
+    const headers = {
+      "Content-Type": "application/json",
+      ...this.config.headers
+    };
+    if (this.config.token) {
+      headers["Authorization"] = `Bearer ${this.config.token}`;
+    }
+    if (this.config.deviceId) {
+      headers["x-device-id"] = this.config.deviceId;
+    }
+    if (this.config.channel) {
+      headers["x-channel"] = this.config.channel;
+    }
+    return headers;
+  }
+  /**
+   * 发送请求
+   */
+  async request(method, path, options) {
+    let url = `${this.config.baseUrl}${path}`;
+    if (options?.params) {
+      const searchParams = new URLSearchParams();
+      Object.entries(options.params).forEach(([key, value]) => {
+        if (value !== void 0) {
+          searchParams.append(key, value);
+        }
+      });
+      const queryString = searchParams.toString();
+      if (queryString) {
+        url += `?${queryString}`;
+      }
+    }
+    let requestConfig = {
+      method,
+      headers: {
+        ...this.getCommonHeaders(),
+        ...options?.headers
+      },
+      body: options?.body ? JSON.stringify(options.body) : void 0
+    };
+    if (this.config.onRequest) {
+      requestConfig = this.config.onRequest(requestConfig);
+    }
+    try {
+      const controller = new AbortController();
+      const timeoutId = setTimeout(() => controller.abort(), this.config.timeout);
+      const response = await fetch(url, {
+        ...requestConfig,
+        signal: controller.signal
+      });
+      clearTimeout(timeoutId);
+      let result = await response.json();
+      if (this.config.onResponse) {
+        result = this.config.onResponse(result);
+      }
+      if (!result.success) {
+        throw new Error(result.message || "Request failed");
+      }
+      return result.data;
+    } catch (error) {
+      if (this.config.onError) {
+        this.config.onError(error);
+      }
+      throw error;
+    }
+  }
+  // ==================== 页面解析 ====================
+  /**
+   * 解析页面
+   * GET /api/page/resolve
+   */
+  async resolvePage(request) {
+    return this.request("GET", "/api/page/resolve", {
+      params: {
+        pageUid: request.pageUid,
+        channel: request.channel,
+        uid: request.uid,
+        deviceId: request.deviceId,
+        previewToken: request.previewToken
+      }
+    });
+  }
+  // ==================== Action Gateway ====================
+  /**
+   * 执行动作
+   * POST /api/actions/execute
+   */
+  async executeAction(request) {
+    return this.request("POST", "/api/actions/execute", {
+      body: request
+    });
+  }
+  /**
+   * 快捷方法：领取
+   */
+  async claim(activityId, params) {
+    return this.executeAction({
+      actionType: "claim",
+      params: { activityId, ...params },
+      context: {
+        deviceId: this.config.deviceId,
+        channel: this.config.channel
+      }
+    });
+  }
+  /**
+   * 快捷方法：签到
+   */
+  async signin(activityId) {
+    return this.executeAction({
+      actionType: "signin",
+      params: { activityId },
+      context: {
+        deviceId: this.config.deviceId,
+        channel: this.config.channel
+      }
+    });
+  }
+  // ==================== Data Proxy ====================
+  /**
+   * 查询数据
+   * POST /api/data/query
+   */
+  async queryData(request) {
+    return this.request("POST", "/api/data/query", {
+      body: request
+    });
+  }
+  /**
+   * 快捷方法：查询数据
+   */
+  async query(queryVersionId, params) {
+    const response = await this.queryData({
+      queryVersionId,
+      params: params || {}
+    });
+    return response.data;
+  }
+  // ==================== 埋点 ====================
+  /**
+   * 上报埋点
+   * POST /api/track
+   */
+  async track(events) {
+    await this.request("POST", "/api/track", {
+      body: { events }
+    });
+  }
+  // ==================== 健康检查 ====================
+  /**
+   * 健康检查
+   * GET /api/health
+   */
+  async health() {
+    return this.request("GET", "/api/health");
+  }
+};
+function createUserClient(config) {
+  return new UserApiClient(config);
+}
+var index_default = UserApiClient;
+export {
+  UserApiClient,
+  createUserClient,
+  index_default as default
+};

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@djvlc/openapi-user-client",
+  "version": "1.0.0",
+  "description": "DJV Low-code Platform - User API 客户端（自动生成）",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "generate": "openapi-typescript ../specs/user-api.yaml -o src/types.ts && npm run build",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "lint": "eslint src/ --ext .ts",
+    "typecheck": "tsc --noEmit",
+    "clean": "rimraf dist",
+    "prepublishOnly": "pnpm run build"
+  },
+  "dependencies": {
+    "@djvlc/contracts-types": "1.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^7.0.0",
+    "@typescript-eslint/parser": "^7.0.0",
+    "eslint": "^8.56.0",
+    "openapi-typescript": "^6.0.0",
+    "rimraf": "^5.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0"
+  },
+  "keywords": [
+    "lowcode",
+    "openapi",
+    "client",
+    "user-api",
+    "djvlc"
+  ],
+  "author": "DJV Team",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/djvlc/contracts.git",
+    "directory": "openapi/user-client"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}