@agile-team/mach-report 0.4.0 → 0.5.0

package/dist/manager.cjs

@@ -0,0 +1,122 @@
+'use strict';
+
+// src/manager/types.ts
+var ReportAdminError = class extends Error {
+  constructor(message, url) {
+    super(message);
+    this.url = url;
+    this.name = "ReportAdminError";
+  }
+};
+
+// src/manager/api.ts
+var BASE = "/report/codePrintReport";
+var LOCK_BASE = "/report/codePrintReportLock";
+function unwrap(response, url) {
+  const body = response;
+  if (body && body.code != null && body.code !== 200) {
+    throw new ReportAdminError(String(body.message || "\u8BF7\u6C42\u5931\u8D25"), url);
+  }
+  return body?.data ?? body;
+}
+function createReportAdminClient(options) {
+  const { request } = options;
+  const base = options.baseUrl ?? "";
+  return {
+    /** 模板列表（分页） */
+    async listReports(query = {}) {
+      const url = `${base}${BASE}/list`;
+      return unwrap(
+        await request({ url, method: "get", params: { current: 1, size: 20, ...query } }),
+        url
+      );
+    },
+    /** 模板详情（content 为 jh4j 私有模板 JSON 字符串，可喂给 importJh4jTemplateContent） */
+    async getReport(id) {
+      const url = `${base}${BASE}/getById`;
+      return unwrap(await request({ url, method: "get", params: { id } }), url);
+    },
+    /** 保存模板（jh4j：PUT，body {id, code, name, content}） */
+    async updateReport(input) {
+      const url = `${base}${BASE}/update`;
+      return unwrap(await request({ url, method: "put", data: input }), url);
+    },
+    /** 导出模板定义包（body = ID 数组，返回 ZIP blob） */
+    async exportDefinition(ids) {
+      const url = `${base}${BASE}/exportDefinition`;
+      return request({ url, method: "post", data: ids });
+    },
+    /** 导入模板定义包（multipart: file + strategy） */
+    async importDefinition(file, strategy) {
+      const url = `${base}${BASE}/importDefinition`;
+      const form = new FormData();
+      form.append("file", file);
+      form.append("strategy", strategy);
+      return request({ url, method: "post", data: form });
+    },
+    /** 数据集列表 */
+    async listDatasets(reportId) {
+      const url = `${base}${BASE}Ds/list`;
+      return unwrap(
+        await request({ url, method: "get", params: { reportId, current: 1, size: 999 } }),
+        url
+      );
+    },
+    /** 参数列表 */
+    async listParams(reportId) {
+      const url = `${base}${BASE}Param/list`;
+      return unwrap(
+        await request({ url, method: "get", params: { reportId, current: 1, size: 999 } }),
+        url
+      );
+    },
+    /** 模板锁：进入设计器前获取（40s 心跳由 holdLock 驱动） */
+    async acquireLock(reportId) {
+      const url = `${base}${LOCK_BASE}/acquire`;
+      return unwrap(await request({ url, method: "post", data: { reportId } }), url);
+    },
+    async lockHeartbeat(reportId) {
+      const url = `${base}${LOCK_BASE}/heartbeat`;
+      return unwrap(await request({ url, method: "post", data: { reportId } }), url);
+    },
+    async releaseLock(reportId) {
+      const url = `${base}${LOCK_BASE}/release`;
+      return unwrap(await request({ url, method: "post", data: { reportId } }), url);
+    },
+    /**
+     * 持锁执行：acquire → fn（期间自动心跳）→ release（finally）。
+     * 返回 fn 的结果；获取锁失败时抛 ReportAdminError。
+     * 心跳连续失败（默认 2 次）视为锁丢失：触发 onLockLost 回调并停止心跳，
+     * fn 继续执行（避免中途丢弃用户编辑），由调用方决定是否提示/中止。
+     */
+    async holdLock(reportId, fn, options2 = {}) {
+      await this.acquireLock(reportId);
+      const failLimit = Math.max(1, options2.heartbeatFailLimit ?? 2);
+      let consecutiveFailures = 0;
+      let lockLost = false;
+      const timer = setInterval(() => {
+        void this.lockHeartbeat(reportId).then(() => {
+          consecutiveFailures = 0;
+        }).catch((e) => {
+          consecutiveFailures++;
+          if (!lockLost && consecutiveFailures >= failLimit) {
+            lockLost = true;
+            options2.onLockLost?.(
+              `\u6A21\u677F\u9501\u5FC3\u8DF3\u8FDE\u7EED ${consecutiveFailures} \u6B21\u5931\u8D25\uFF08${e instanceof Error ? e.message : String(e)}\uFF09\uFF0C\u9501\u53EF\u80FD\u5DF2\u88AB\u91CA\u653E`
+            );
+            clearInterval(timer);
+          }
+        });
+      }, 4e4);
+      try {
+        return await fn();
+      } finally {
+        clearInterval(timer);
+        await this.releaseLock(reportId).catch(() => void 0);
+      }
+    }
+  };
+}
+
+exports.ReportAdminError = ReportAdminError;
+exports.createReportAdminClient = createReportAdminClient;

package/dist/{manager/api.d.ts → manager.d.cts}

@@ -1,5 +1,55 @@
-import type { DatasetRecord, ImportStrategy, PageResult, ParamRecord, ReportRecord, RequestFn } from "./types";
-export declare function createReportAdminClient(options: {
+interface ReportRecord {
+    id: string;
+    code?: string;
+    name?: string;
+    publishStatus?: string;
+    directoryId?: string;
+    updateTime?: string;
+    [key: string]: unknown;
+}
+interface PageResult<T> {
+    records: T[];
+    total?: number;
+    current?: number;
+    size?: number;
+}
+interface DatasetRecord {
+    id?: string;
+    reportId?: string;
+    code?: string;
+    name?: string;
+    type?: string;
+    datasourceCode?: string;
+    sqlText?: string;
+    apiUrl?: string;
+    fields?: unknown[];
+    [key: string]: unknown;
+}
+interface ParamRecord {
+    id?: string;
+    reportId?: string;
+    name?: string;
+    defaultValue?: string;
+    [key: string]: unknown;
+}
+type ImportStrategy = "overwrite" | "skip";
+type RequestFn = (config: {
+    url: string;
+    method: string;
+    params?: Record<string, unknown>;
+    data?: unknown;
+}) => Promise<unknown>;
+interface ApiResponse<T = unknown> {
+    code?: number;
+    message?: string;
+    data?: T;
+}
+declare class ReportAdminError extends Error {
+    readonly url: string;
+    constructor(message: string, url: string);
+}
+
+declare function createReportAdminClient(options: {
     request: RequestFn;
     baseUrl?: string;
 }): {
@@ -42,4 +92,6 @@ export declare function createReportAdminClient(options: {
         heartbeatFailLimit?: number;
     }): Promise<T>;
 };
-export type ReportAdminClient = ReturnType<typeof createReportAdminClient>;
+type ReportAdminClient = ReturnType<typeof createReportAdminClient>;
+
+export { type ApiResponse, type DatasetRecord, type ImportStrategy, type PageResult, type ParamRecord, type ReportAdminClient, ReportAdminError, type ReportRecord, type RequestFn, createReportAdminClient };

package/dist/manager.d.ts

@@ -1,5 +1,97 @@
-/**
- * 管理端 API 子路径入口（@agile-team/mach-report/manager）：
- * 模板/数据集/参数/导入导出/模板锁（接口面对齐 jh4j 逆向结果）。
- */
-export * from "./manager/index";
+interface ReportRecord {
+    id: string;
+    code?: string;
+    name?: string;
+    publishStatus?: string;
+    directoryId?: string;
+    updateTime?: string;
+    [key: string]: unknown;
+}
+interface PageResult<T> {
+    records: T[];
+    total?: number;
+    current?: number;
+    size?: number;
+}
+interface DatasetRecord {
+    id?: string;
+    reportId?: string;
+    code?: string;
+    name?: string;
+    type?: string;
+    datasourceCode?: string;
+    sqlText?: string;
+    apiUrl?: string;
+    fields?: unknown[];
+    [key: string]: unknown;
+}
+interface ParamRecord {
+    id?: string;
+    reportId?: string;
+    name?: string;
+    defaultValue?: string;
+    [key: string]: unknown;
+}
+type ImportStrategy = "overwrite" | "skip";
+type RequestFn = (config: {
+    url: string;
+    method: string;
+    params?: Record<string, unknown>;
+    data?: unknown;
+}) => Promise<unknown>;
+interface ApiResponse<T = unknown> {
+    code?: number;
+    message?: string;
+    data?: T;
+}
+declare class ReportAdminError extends Error {
+    readonly url: string;
+    constructor(message: string, url: string);
+}
+
+declare function createReportAdminClient(options: {
+    request: RequestFn;
+    baseUrl?: string;
+}): {
+    /** 模板列表（分页） */
+    listReports(query?: {
+        current?: number;
+        size?: number;
+        directoryId?: string;
+        keyword?: string;
+    }): Promise<PageResult<ReportRecord>>;
+    /** 模板详情（content 为 jh4j 私有模板 JSON 字符串，可喂给 importJh4jTemplateContent） */
+    getReport(id: string): Promise<ReportRecord>;
+    /** 保存模板（jh4j：PUT，body {id, code, name, content}） */
+    updateReport(input: {
+        id: string;
+        code?: string;
+        name?: string;
+        content: string;
+    }): Promise<unknown>;
+    /** 导出模板定义包（body = ID 数组，返回 ZIP blob） */
+    exportDefinition(ids: string[]): Promise<unknown>;
+    /** 导入模板定义包（multipart: file + strategy） */
+    importDefinition(file: File | Blob, strategy: ImportStrategy): Promise<unknown>;
+    /** 数据集列表 */
+    listDatasets(reportId: string): Promise<PageResult<DatasetRecord>>;
+    /** 参数列表 */
+    listParams(reportId: string): Promise<PageResult<ParamRecord>>;
+    /** 模板锁：进入设计器前获取（40s 心跳由 holdLock 驱动） */
+    acquireLock(reportId: string): Promise<unknown>;
+    lockHeartbeat(reportId: string): Promise<unknown>;
+    releaseLock(reportId: string): Promise<unknown>;
+    /**
+     * 持锁执行：acquire → fn（期间自动心跳）→ release（finally）。
+     * 返回 fn 的结果；获取锁失败时抛 ReportAdminError。
+     * 心跳连续失败（默认 2 次）视为锁丢失：触发 onLockLost 回调并停止心跳，
+     * fn 继续执行（避免中途丢弃用户编辑），由调用方决定是否提示/中止。
+     */
+    holdLock<T>(reportId: string, fn: () => Promise<T>, options?: {
+        onLockLost?: (reason: string) => void;
+        heartbeatFailLimit?: number;
+    }): Promise<T>;
+};
+type ReportAdminClient = ReturnType<typeof createReportAdminClient>;
+
+export { type ApiResponse, type DatasetRecord, type ImportStrategy, type PageResult, type ParamRecord, type ReportAdminClient, ReportAdminError, type ReportRecord, type RequestFn, createReportAdminClient };

package/dist/manager.js

@@ -1,6 +1,119 @@
-/**
- * 管理端 API 子路径入口（@agile-team/mach-report/manager）：
- * 模板/数据集/参数/导入导出/模板锁（接口面对齐 jh4j 逆向结果）。
- */
-export * from "./manager/index";
-//# sourceMappingURL=manager.js.map
+// src/manager/types.ts
+var ReportAdminError = class extends Error {
+  constructor(message, url) {
+    super(message);
+    this.url = url;
+    this.name = "ReportAdminError";
+  }
+};
+
+// src/manager/api.ts
+var BASE = "/report/codePrintReport";
+var LOCK_BASE = "/report/codePrintReportLock";
+function unwrap(response, url) {
+  const body = response;
+  if (body && body.code != null && body.code !== 200) {
+    throw new ReportAdminError(String(body.message || "\u8BF7\u6C42\u5931\u8D25"), url);
+  }
+  return body?.data ?? body;
+}
+function createReportAdminClient(options) {
+  const { request } = options;
+  const base = options.baseUrl ?? "";
+  return {
+    /** 模板列表（分页） */
+    async listReports(query = {}) {
+      const url = `${base}${BASE}/list`;
+      return unwrap(
+        await request({ url, method: "get", params: { current: 1, size: 20, ...query } }),
+        url
+      );
+    },
+    /** 模板详情（content 为 jh4j 私有模板 JSON 字符串，可喂给 importJh4jTemplateContent） */
+    async getReport(id) {
+      const url = `${base}${BASE}/getById`;
+      return unwrap(await request({ url, method: "get", params: { id } }), url);
+    },
+    /** 保存模板（jh4j：PUT，body {id, code, name, content}） */
+    async updateReport(input) {
+      const url = `${base}${BASE}/update`;
+      return unwrap(await request({ url, method: "put", data: input }), url);
+    },
+    /** 导出模板定义包（body = ID 数组，返回 ZIP blob） */
+    async exportDefinition(ids) {
+      const url = `${base}${BASE}/exportDefinition`;
+      return request({ url, method: "post", data: ids });
+    },
+    /** 导入模板定义包（multipart: file + strategy） */
+    async importDefinition(file, strategy) {
+      const url = `${base}${BASE}/importDefinition`;
+      const form = new FormData();
+      form.append("file", file);
+      form.append("strategy", strategy);
+      return request({ url, method: "post", data: form });
+    },
+    /** 数据集列表 */
+    async listDatasets(reportId) {
+      const url = `${base}${BASE}Ds/list`;
+      return unwrap(
+        await request({ url, method: "get", params: { reportId, current: 1, size: 999 } }),
+        url
+      );
+    },
+    /** 参数列表 */
+    async listParams(reportId) {
+      const url = `${base}${BASE}Param/list`;
+      return unwrap(
+        await request({ url, method: "get", params: { reportId, current: 1, size: 999 } }),
+        url
+      );
+    },
+    /** 模板锁：进入设计器前获取（40s 心跳由 holdLock 驱动） */
+    async acquireLock(reportId) {
+      const url = `${base}${LOCK_BASE}/acquire`;
+      return unwrap(await request({ url, method: "post", data: { reportId } }), url);
+    },
+    async lockHeartbeat(reportId) {
+      const url = `${base}${LOCK_BASE}/heartbeat`;
+      return unwrap(await request({ url, method: "post", data: { reportId } }), url);
+    },
+    async releaseLock(reportId) {
+      const url = `${base}${LOCK_BASE}/release`;
+      return unwrap(await request({ url, method: "post", data: { reportId } }), url);
+    },
+    /**
+     * 持锁执行：acquire → fn（期间自动心跳）→ release（finally）。
+     * 返回 fn 的结果；获取锁失败时抛 ReportAdminError。
+     * 心跳连续失败（默认 2 次）视为锁丢失：触发 onLockLost 回调并停止心跳，
+     * fn 继续执行（避免中途丢弃用户编辑），由调用方决定是否提示/中止。
+     */
+    async holdLock(reportId, fn, options2 = {}) {
+      await this.acquireLock(reportId);
+      const failLimit = Math.max(1, options2.heartbeatFailLimit ?? 2);
+      let consecutiveFailures = 0;
+      let lockLost = false;
+      const timer = setInterval(() => {
+        void this.lockHeartbeat(reportId).then(() => {
+          consecutiveFailures = 0;
+        }).catch((e) => {
+          consecutiveFailures++;
+          if (!lockLost && consecutiveFailures >= failLimit) {
+            lockLost = true;
+            options2.onLockLost?.(
+              `\u6A21\u677F\u9501\u5FC3\u8DF3\u8FDE\u7EED ${consecutiveFailures} \u6B21\u5931\u8D25\uFF08${e instanceof Error ? e.message : String(e)}\uFF09\uFF0C\u9501\u53EF\u80FD\u5DF2\u88AB\u91CA\u653E`
+            );
+            clearInterval(timer);
+          }
+        });
+      }, 4e4);
+      try {
+        return await fn();
+      } finally {
+        clearInterval(timer);
+        await this.releaseLock(reportId).catch(() => void 0);
+      }
+    }
+  };
+}
+
+export { ReportAdminError, createReportAdminClient };