zentao-api 0.5.2 → 0.5.3

package/dist/index.d.ts

@@ -2,7 +2,7 @@ export { ZentaoClient } from './client/index.js';
 export { ERRORS, ZentaoError, type ErrorCode } from './misc/errors.js';
 export { getGlobalOptions, setGlobalOptions } from './misc/global-options.js';
 export { ZENTAO_PROFILES_STORAGE_KEY, addProfile, deleteProfile, getAllProfiles, getProfile, getProfileKey, switchProfile, } from './profiles/index.js';
-export { defineModuleActions, defineModules, type DefineModulesOptions, extendModuleAction, getModuleNames, getModule, getModuleAction, getModuleActionParams, getObjectProps, } from './modules/registry.js';
+export { defineModuleActions, defineModules, type DefineModulesOptions, type ExportRegistryOptions, type ExportedModuleAction, type ExportedModuleDefinition, exportRegistry, extendModuleAction, getModuleNames, getModule, getModuleAction, getModuleActionParams, getObjectProps, } from './modules/registry.js';
 export { request, type BuiltinRequestName, type RequestParamsFor, type RequestResultFor, } from './request/index.js';
 export { pickFields, pickFieldsSingle, filterData, searchData, sortData, processData, } from './utils/index.js';
 export { BUILD, VERSION } from './version.js';

package/dist/index.js

@@ -2,7 +2,7 @@ export { ZentaoClient } from './client/index.js';
 export { ERRORS, ZentaoError } from './misc/errors.js';
 export { getGlobalOptions, setGlobalOptions } from './misc/global-options.js';
 export { ZENTAO_PROFILES_STORAGE_KEY, addProfile, deleteProfile, getAllProfiles, getProfile, getProfileKey, switchProfile, } from './profiles/index.js';
-export { defineModuleActions, defineModules, extendModuleAction, getModuleNames, getModule, getModuleAction, getModuleActionParams, getObjectProps, } from './modules/registry.js';
+export { defineModuleActions, defineModules, exportRegistry, extendModuleAction, getModuleNames, getModule, getModuleAction, getModuleActionParams, getObjectProps, } from './modules/registry.js';
 export { request, } from './request/index.js';
 export { pickFields, pickFieldsSingle, filterData, searchData, sortData, processData, } from './utils/index.js';
 export { BUILD, VERSION } from './version.js';

package/dist/modules/export.d.ts

@@ -0,0 +1,33 @@
+import type { ModuleAction, ModuleActionParam, ModuleDefinition } from '../types/index.js';
+/** 导出的模块动作定义。 */
+export type ExportedModuleAction = Omit<ModuleAction, 'requestBody'> & {
+    bodyParams: ModuleActionParam[];
+};
+/** 导出的模块定义。 */
+export type ExportedModuleDefinition = Omit<ModuleDefinition, 'actions'> & {
+    actions: ExportedModuleAction[];
+};
+/** {@link exportRegistry} 的选项。 */
+export interface ExportRegistryOptions {
+    /** 是否保留注册表中的原始模块定义。 */
+    raw?: boolean;
+    /** 是否递归移除值为函数的属性；默认为 `true`。 */
+    jsonSafe?: boolean;
+}
+/**
+ * 导出注册表。
+ *
+ * 默认会把动作的 `requestBody` 转换成扁平的 `bodyParams`；传入 `raw: true`
+ * 时则保留原始模块结构。默认还会递归移除函数属性，以便安全地序列化为 JSON；
+ * 如需保留函数，可传入 `jsonSafe: false`。
+ *
+ * @param options - 导出选项。
+ * @returns 以模块名为键的模块定义。
+ */
+export declare function exportRegistry(options: ExportRegistryOptions & {
+    raw: true;
+}): Record<string, ModuleDefinition>;
+export declare function exportRegistry(options?: ExportRegistryOptions & {
+    raw?: false;
+}): Record<string, ExportedModuleDefinition>;
+export declare function exportRegistry(options: ExportRegistryOptions): Record<string, ModuleDefinition | ExportedModuleDefinition>;

package/dist/modules/export.js

@@ -0,0 +1,42 @@
+import { getModuleActionParams } from './query.js';
+import { getModuleMapState } from './registry-store.js';
+function removeFunctions(value) {
+    if (Array.isArray(value)) {
+        return value
+            .filter((item) => typeof item !== 'function')
+            .map((item) => removeFunctions(item));
+    }
+    if (value && typeof value === 'object') {
+        const result = {};
+        for (const [key, item] of Object.entries(value)) {
+            if (typeof item !== 'function') {
+                result[key] = removeFunctions(item);
+            }
+        }
+        return result;
+    }
+    return value;
+}
+export function exportRegistry(options = {}) {
+    const raw = options.raw ?? false;
+    const jsonSafe = options.jsonSafe ?? true;
+    const registry = {};
+    getModuleMapState().forEach((module) => {
+        const definition = raw
+            ? module
+            : {
+                ...module,
+                actions: module.actions.map((action) => {
+                    const { requestBody, ...exportedAction } = action;
+                    return {
+                        ...exportedAction,
+                        bodyParams: requestBody
+                            ? getModuleActionParams(module.name, action.name, { roles: ['body'] })
+                            : [],
+                    };
+                }),
+            };
+        registry[module.name] = jsonSafe ? removeFunctions(definition) : definition;
+    });
+    return registry;
+}

package/dist/modules/registry.d.ts

@@ -4239,3 +4239,4 @@ export declare const MODULES: readonly [{
 export { type DefineModulesOptions, defineModules, defineModuleActions, extendModuleAction, resetModuleDefinitions, } from './define.js';
 export { applyBuiltinOverrides };
 export { getModule, getModuleAction, getModuleActionParams, getModuleNames, isModuleName, getObjectProps, } from './query.js';
+export { type ExportRegistryOptions, type ExportedModuleAction, type ExportedModuleDefinition, exportRegistry, } from './export.js';

package/dist/modules/registry.js

@@ -17,3 +17,4 @@ export { applyBuiltinOverrides };
 setPostResetHook(applyBuiltinOverrides);
 applyBuiltinOverrides();
 export { getModule, getModuleAction, getModuleActionParams, getModuleNames, isModuleName, getObjectProps, } from './query.js';
+export { exportRegistry, } from './export.js';

package/dist/version.js

@@ -1,5 +1,5 @@
-const fallbackBuild = "2026-08-11T15:04:25.839Z";
-const fallbackVersion = "0.5.2";
+const fallbackBuild = "2026-08-12T03:04:33.420Z";
+const fallbackVersion = "0.5.3";
 /**
  * 构建标识，由构建脚本通过 `__ZENTAO_API_BUILD__` 注入。
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zentao-api",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "type": "module",
   "description": "Browser and Node.js SDK for ZenTao API",
   "license": "MIT",