@djvlc/openapi-admin-client 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,127 @@
+import { ApiResponse, PaginatedApiResponse, PageSchema, PublishConfig, VersionInfo, ComponentMeta, ActionDefinition, DataQueryDefinition } from '@djvlc/contracts-types';
+
+/**
+ * @djvlc/openapi-admin-client - Admin API 客户端
+ *
+ * 自动从 OpenAPI 规范生成，提供类型安全的 Admin API 访问
+ *
+ * @packageDocumentation
+ */
+
+interface AdminClientConfig {
+    /** API 基础 URL */
+    baseUrl: string;
+    /** 认证 Token */
+    token?: string;
+    /** 请求超时（毫秒） */
+    timeout?: number;
+    /** 自定义请求头 */
+    headers?: Record<string, string>;
+    /** 请求拦截器 */
+    onRequest?: (config: RequestInit) => RequestInit;
+    /** 响应拦截器 */
+    onResponse?: <T>(response: ApiResponse<T>) => ApiResponse<T>;
+    /** 错误处理 */
+    onError?: (error: Error) => void;
+}
+/** 创建页面请求 */
+interface CreatePageRequest {
+    title: string;
+    description?: string;
+    templateId?: string;
+    workspaceId?: string;
+}
+/** 更新页面请求 */
+interface UpdatePageRequest {
+    title?: string;
+    description?: string;
+    schema?: PageSchema;
+}
+/** 页面列表查询参数 */
+interface ListPagesParams {
+    page?: number;
+    pageSize?: number;
+    status?: 'draft' | 'published';
+    search?: string;
+    sortBy?: string;
+    sortOrder?: 'asc' | 'desc';
+}
+/** 页面详情响应 */
+interface PageDetail {
+    id: string;
+    uid: string;
+    title: string;
+    description?: string;
+    status: 'draft' | 'published';
+    schema: PageSchema;
+    currentVersionId?: string;
+    createdAt: string;
+    updatedAt: string;
+    createdBy: string;
+}
+/** 组件列表查询参数 */
+interface ListComponentsParams {
+    page?: number;
+    pageSize?: number;
+    category?: string;
+    status?: string;
+    search?: string;
+}
+/** 发布结果 */
+interface PublishResult {
+    pageVersionId: string;
+    manifestId: string;
+    publishedAt: string;
+    channel: string;
+}
+/**
+ * Admin API 客户端类
+ */
+declare class AdminApiClient {
+    private config;
+    constructor(config: AdminClientConfig);
+    /**
+     * 发送请求
+     */
+    private request;
+    /** 获取页面列表 */
+    listPages(params?: ListPagesParams): Promise<PaginatedApiResponse<PageDetail>>;
+    /** 获取页面详情 */
+    getPage(pageId: string): Promise<ApiResponse<PageDetail>>;
+    /** 创建页面 */
+    createPage(data: CreatePageRequest): Promise<ApiResponse<PageDetail>>;
+    /** 更新页面 */
+    updatePage(pageId: string, data: UpdatePageRequest): Promise<ApiResponse<PageDetail>>;
+    /** 删除页面 */
+    deletePage(pageId: string): Promise<ApiResponse<void>>;
+    /** 保存草稿 */
+    saveDraft(pageId: string, schema: PageSchema): Promise<ApiResponse<void>>;
+    /** 发布页面 */
+    publishPage(pageId: string, config: PublishConfig): Promise<ApiResponse<PublishResult>>;
+    /** 回滚页面 */
+    rollbackPage(pageId: string, versionId: string): Promise<ApiResponse<void>>;
+    /** 获取版本历史 */
+    getVersionHistory(pageId: string): Promise<ApiResponse<VersionInfo[]>>;
+    /** 获取组件列表 */
+    listComponents(params?: ListComponentsParams): Promise<PaginatedApiResponse<ComponentMeta>>;
+    /** 获取组件详情 */
+    getComponent(name: string, version?: string): Promise<ApiResponse<ComponentMeta>>;
+    /** 阻断组件版本 */
+    blockComponent(name: string, version: string, reason: string): Promise<ApiResponse<void>>;
+    /** 解除组件阻断 */
+    unblockComponent(name: string, version: string): Promise<ApiResponse<void>>;
+    /** 获取 ActionDefinition 列表 */
+    listActionDefinitions(): Promise<ApiResponse<ActionDefinition[]>>;
+    /** 创建 ActionDefinition */
+    createActionDefinition(data: Omit<ActionDefinition, 'id'>): Promise<ApiResponse<ActionDefinition>>;
+    /** 获取 DataQueryDefinition 列表 */
+    listDataQueryDefinitions(): Promise<ApiResponse<DataQueryDefinition[]>>;
+    /** 创建 DataQueryDefinition */
+    createDataQueryDefinition(data: Omit<DataQueryDefinition, 'id'>): Promise<ApiResponse<DataQueryDefinition>>;
+}
+/**
+ * 创建 Admin API 客户端实例
+ */
+declare function createAdminClient(config: AdminClientConfig): AdminApiClient;
+
+export { AdminApiClient, type AdminClientConfig, type CreatePageRequest, type ListComponentsParams, type ListPagesParams, type PageDetail, type PublishResult, type UpdatePageRequest, createAdminClient, AdminApiClient as default };

package/dist/index.d.ts

@@ -0,0 +1,127 @@
+import { ApiResponse, PaginatedApiResponse, PageSchema, PublishConfig, VersionInfo, ComponentMeta, ActionDefinition, DataQueryDefinition } from '@djvlc/contracts-types';
+
+/**
+ * @djvlc/openapi-admin-client - Admin API 客户端
+ *
+ * 自动从 OpenAPI 规范生成，提供类型安全的 Admin API 访问
+ *
+ * @packageDocumentation
+ */
+
+interface AdminClientConfig {
+    /** API 基础 URL */
+    baseUrl: string;
+    /** 认证 Token */
+    token?: string;
+    /** 请求超时（毫秒） */
+    timeout?: number;
+    /** 自定义请求头 */
+    headers?: Record<string, string>;
+    /** 请求拦截器 */
+    onRequest?: (config: RequestInit) => RequestInit;
+    /** 响应拦截器 */
+    onResponse?: <T>(response: ApiResponse<T>) => ApiResponse<T>;
+    /** 错误处理 */
+    onError?: (error: Error) => void;
+}
+/** 创建页面请求 */
+interface CreatePageRequest {
+    title: string;
+    description?: string;
+    templateId?: string;
+    workspaceId?: string;
+}
+/** 更新页面请求 */
+interface UpdatePageRequest {
+    title?: string;
+    description?: string;
+    schema?: PageSchema;
+}
+/** 页面列表查询参数 */
+interface ListPagesParams {
+    page?: number;
+    pageSize?: number;
+    status?: 'draft' | 'published';
+    search?: string;
+    sortBy?: string;
+    sortOrder?: 'asc' | 'desc';
+}
+/** 页面详情响应 */
+interface PageDetail {
+    id: string;
+    uid: string;
+    title: string;
+    description?: string;
+    status: 'draft' | 'published';
+    schema: PageSchema;
+    currentVersionId?: string;
+    createdAt: string;
+    updatedAt: string;
+    createdBy: string;
+}
+/** 组件列表查询参数 */
+interface ListComponentsParams {
+    page?: number;
+    pageSize?: number;
+    category?: string;
+    status?: string;
+    search?: string;
+}
+/** 发布结果 */
+interface PublishResult {
+    pageVersionId: string;
+    manifestId: string;
+    publishedAt: string;
+    channel: string;
+}
+/**
+ * Admin API 客户端类
+ */
+declare class AdminApiClient {
+    private config;
+    constructor(config: AdminClientConfig);
+    /**
+     * 发送请求
+     */
+    private request;
+    /** 获取页面列表 */
+    listPages(params?: ListPagesParams): Promise<PaginatedApiResponse<PageDetail>>;
+    /** 获取页面详情 */
+    getPage(pageId: string): Promise<ApiResponse<PageDetail>>;
+    /** 创建页面 */
+    createPage(data: CreatePageRequest): Promise<ApiResponse<PageDetail>>;
+    /** 更新页面 */
+    updatePage(pageId: string, data: UpdatePageRequest): Promise<ApiResponse<PageDetail>>;
+    /** 删除页面 */
+    deletePage(pageId: string): Promise<ApiResponse<void>>;
+    /** 保存草稿 */
+    saveDraft(pageId: string, schema: PageSchema): Promise<ApiResponse<void>>;
+    /** 发布页面 */
+    publishPage(pageId: string, config: PublishConfig): Promise<ApiResponse<PublishResult>>;
+    /** 回滚页面 */
+    rollbackPage(pageId: string, versionId: string): Promise<ApiResponse<void>>;
+    /** 获取版本历史 */
+    getVersionHistory(pageId: string): Promise<ApiResponse<VersionInfo[]>>;
+    /** 获取组件列表 */
+    listComponents(params?: ListComponentsParams): Promise<PaginatedApiResponse<ComponentMeta>>;
+    /** 获取组件详情 */
+    getComponent(name: string, version?: string): Promise<ApiResponse<ComponentMeta>>;
+    /** 阻断组件版本 */
+    blockComponent(name: string, version: string, reason: string): Promise<ApiResponse<void>>;
+    /** 解除组件阻断 */
+    unblockComponent(name: string, version: string): Promise<ApiResponse<void>>;
+    /** 获取 ActionDefinition 列表 */
+    listActionDefinitions(): Promise<ApiResponse<ActionDefinition[]>>;
+    /** 创建 ActionDefinition */
+    createActionDefinition(data: Omit<ActionDefinition, 'id'>): Promise<ApiResponse<ActionDefinition>>;
+    /** 获取 DataQueryDefinition 列表 */
+    listDataQueryDefinitions(): Promise<ApiResponse<DataQueryDefinition[]>>;
+    /** 创建 DataQueryDefinition */
+    createDataQueryDefinition(data: Omit<DataQueryDefinition, 'id'>): Promise<ApiResponse<DataQueryDefinition>>;
+}
+/**
+ * 创建 Admin API 客户端实例
+ */
+declare function createAdminClient(config: AdminClientConfig): AdminApiClient;
+
+export { AdminApiClient, type AdminClientConfig, type CreatePageRequest, type ListComponentsParams, type ListPagesParams, type PageDetail, type PublishResult, type UpdatePageRequest, createAdminClient, AdminApiClient as default };

package/dist/index.js

@@ -0,0 +1,167 @@
+"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, {
+  AdminApiClient: () => AdminApiClient,
+  createAdminClient: () => createAdminClient,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var AdminApiClient = class {
+  constructor(config) {
+    this.config = {
+      timeout: 3e4,
+      ...config
+    };
+  }
+  /**
+   * 发送请求
+   */
+  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, String(value));
+        }
+      });
+      const queryString = searchParams.toString();
+      if (queryString) {
+        url += `?${queryString}`;
+      }
+    }
+    let requestConfig = {
+      method,
+      headers: {
+        "Content-Type": "application/json",
+        ...this.config.token ? { Authorization: `Bearer ${this.config.token}` } : {},
+        ...this.config.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);
+      }
+      return result;
+    } catch (error) {
+      if (this.config.onError) {
+        this.config.onError(error);
+      }
+      throw error;
+    }
+  }
+  // ==================== 页面管理 ====================
+  /** 获取页面列表 */
+  async listPages(params) {
+    return this.request("GET", "/api/admin/pages", { params });
+  }
+  /** 获取页面详情 */
+  async getPage(pageId) {
+    return this.request("GET", `/api/admin/pages/${pageId}`);
+  }
+  /** 创建页面 */
+  async createPage(data) {
+    return this.request("POST", "/api/admin/pages", { body: data });
+  }
+  /** 更新页面 */
+  async updatePage(pageId, data) {
+    return this.request("PUT", `/api/admin/pages/${pageId}`, { body: data });
+  }
+  /** 删除页面 */
+  async deletePage(pageId) {
+    return this.request("DELETE", `/api/admin/pages/${pageId}`);
+  }
+  /** 保存草稿 */
+  async saveDraft(pageId, schema) {
+    return this.request("POST", `/api/admin/pages/${pageId}/draft`, { body: { schema } });
+  }
+  /** 发布页面 */
+  async publishPage(pageId, config) {
+    return this.request("POST", `/api/admin/pages/${pageId}/publish`, { body: config });
+  }
+  /** 回滚页面 */
+  async rollbackPage(pageId, versionId) {
+    return this.request("POST", `/api/admin/pages/${pageId}/rollback`, { body: { versionId } });
+  }
+  /** 获取版本历史 */
+  async getVersionHistory(pageId) {
+    return this.request("GET", `/api/admin/pages/${pageId}/versions`);
+  }
+  // ==================== 组件管理 ====================
+  /** 获取组件列表 */
+  async listComponents(params) {
+    return this.request("GET", "/api/admin/components", { params });
+  }
+  /** 获取组件详情 */
+  async getComponent(name, version) {
+    const path = version ? `/api/admin/components/${name}/versions/${version}` : `/api/admin/components/${name}`;
+    return this.request("GET", path);
+  }
+  /** 阻断组件版本 */
+  async blockComponent(name, version, reason) {
+    return this.request("POST", `/api/admin/components/${name}/versions/${version}/block`, {
+      body: { reason }
+    });
+  }
+  /** 解除组件阻断 */
+  async unblockComponent(name, version) {
+    return this.request("POST", `/api/admin/components/${name}/versions/${version}/unblock`);
+  }
+  // ==================== Definition 管理 ====================
+  /** 获取 ActionDefinition 列表 */
+  async listActionDefinitions() {
+    return this.request("GET", "/api/admin/definitions/actions");
+  }
+  /** 创建 ActionDefinition */
+  async createActionDefinition(data) {
+    return this.request("POST", "/api/admin/definitions/actions", { body: data });
+  }
+  /** 获取 DataQueryDefinition 列表 */
+  async listDataQueryDefinitions() {
+    return this.request("GET", "/api/admin/definitions/queries");
+  }
+  /** 创建 DataQueryDefinition */
+  async createDataQueryDefinition(data) {
+    return this.request("POST", "/api/admin/definitions/queries", { body: data });
+  }
+};
+function createAdminClient(config) {
+  return new AdminApiClient(config);
+}
+var index_default = AdminApiClient;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AdminApiClient,
+  createAdminClient
+});

package/dist/index.mjs

@@ -0,0 +1,141 @@
+// src/index.ts
+var AdminApiClient = class {
+  constructor(config) {
+    this.config = {
+      timeout: 3e4,
+      ...config
+    };
+  }
+  /**
+   * 发送请求
+   */
+  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, String(value));
+        }
+      });
+      const queryString = searchParams.toString();
+      if (queryString) {
+        url += `?${queryString}`;
+      }
+    }
+    let requestConfig = {
+      method,
+      headers: {
+        "Content-Type": "application/json",
+        ...this.config.token ? { Authorization: `Bearer ${this.config.token}` } : {},
+        ...this.config.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);
+      }
+      return result;
+    } catch (error) {
+      if (this.config.onError) {
+        this.config.onError(error);
+      }
+      throw error;
+    }
+  }
+  // ==================== 页面管理 ====================
+  /** 获取页面列表 */
+  async listPages(params) {
+    return this.request("GET", "/api/admin/pages", { params });
+  }
+  /** 获取页面详情 */
+  async getPage(pageId) {
+    return this.request("GET", `/api/admin/pages/${pageId}`);
+  }
+  /** 创建页面 */
+  async createPage(data) {
+    return this.request("POST", "/api/admin/pages", { body: data });
+  }
+  /** 更新页面 */
+  async updatePage(pageId, data) {
+    return this.request("PUT", `/api/admin/pages/${pageId}`, { body: data });
+  }
+  /** 删除页面 */
+  async deletePage(pageId) {
+    return this.request("DELETE", `/api/admin/pages/${pageId}`);
+  }
+  /** 保存草稿 */
+  async saveDraft(pageId, schema) {
+    return this.request("POST", `/api/admin/pages/${pageId}/draft`, { body: { schema } });
+  }
+  /** 发布页面 */
+  async publishPage(pageId, config) {
+    return this.request("POST", `/api/admin/pages/${pageId}/publish`, { body: config });
+  }
+  /** 回滚页面 */
+  async rollbackPage(pageId, versionId) {
+    return this.request("POST", `/api/admin/pages/${pageId}/rollback`, { body: { versionId } });
+  }
+  /** 获取版本历史 */
+  async getVersionHistory(pageId) {
+    return this.request("GET", `/api/admin/pages/${pageId}/versions`);
+  }
+  // ==================== 组件管理 ====================
+  /** 获取组件列表 */
+  async listComponents(params) {
+    return this.request("GET", "/api/admin/components", { params });
+  }
+  /** 获取组件详情 */
+  async getComponent(name, version) {
+    const path = version ? `/api/admin/components/${name}/versions/${version}` : `/api/admin/components/${name}`;
+    return this.request("GET", path);
+  }
+  /** 阻断组件版本 */
+  async blockComponent(name, version, reason) {
+    return this.request("POST", `/api/admin/components/${name}/versions/${version}/block`, {
+      body: { reason }
+    });
+  }
+  /** 解除组件阻断 */
+  async unblockComponent(name, version) {
+    return this.request("POST", `/api/admin/components/${name}/versions/${version}/unblock`);
+  }
+  // ==================== Definition 管理 ====================
+  /** 获取 ActionDefinition 列表 */
+  async listActionDefinitions() {
+    return this.request("GET", "/api/admin/definitions/actions");
+  }
+  /** 创建 ActionDefinition */
+  async createActionDefinition(data) {
+    return this.request("POST", "/api/admin/definitions/actions", { body: data });
+  }
+  /** 获取 DataQueryDefinition 列表 */
+  async listDataQueryDefinitions() {
+    return this.request("GET", "/api/admin/definitions/queries");
+  }
+  /** 创建 DataQueryDefinition */
+  async createDataQueryDefinition(data) {
+    return this.request("POST", "/api/admin/definitions/queries", { body: data });
+  }
+};
+function createAdminClient(config) {
+  return new AdminApiClient(config);
+}
+var index_default = AdminApiClient;
+export {
+  AdminApiClient,
+  createAdminClient,
+  index_default as default
+};

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@djvlc/openapi-admin-client",
+  "version": "1.0.0",
+  "description": "DJV Low-code Platform - Admin 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/admin-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",
+    "admin-api",
+    "djvlc"
+  ],
+  "author": "DJV Team",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/djvlc/contracts.git",
+    "directory": "openapi/admin-client"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}