authing_ruby 1.0.6

data/lib/authing_ruby/test/js_sdk_test/node_modules/authing-js-sdk/build/main/lib/management/StatisticsManagementClient.d.ts

@@ -0,0 +1,56 @@
+import { AdminLogsInfo, ManagementClientOptions, UserLogsInfo } from './types';
+import { ManagementTokenProvider } from './ManagementTokenProvider';
+import { HttpClient } from '../common/HttpClient';
+/**
+ * @class StatisticsManagementClient 管理日志统计信息
+ * @name StatisticsManagementClient
+ * @description 管理日志统计信息
+ *
+ * @example
+ *
+ * 请使用以下方式使用该模块：
+ * \`\`\`javascript
+ * import { StatisticsManagementClient } from "authing-js-sdk"
+ * const managementClient = new ManagementClient({
+ *    userPoolId: "YOUR_USERPOOL_ID",
+ *    secret: "YOUR_USERPOOL_SECRET",
+ * })
+ * managementClient.statistics.listUserActions // 查看用户操作日志
+ * managementClient.statistics.listAuditLogs // 查看审计日志
+ * \`\`\`
+ *
+ */
+export declare class StatisticsManagementClient {
+    options: ManagementClientOptions;
+    httpClient: HttpClient;
+    tokenProvider: ManagementTokenProvider;
+    constructor(options: ManagementClientOptions, httpClient: HttpClient, tokenProvider: ManagementTokenProvider);
+    /**
+     * 查看用户操作日志
+     * @param options.operationNames SupportedUserActionEnum
+     */
+    listUserActions(options?: {
+        clientIp?: string;
+        operationNames?: string[];
+        userIds?: string[];
+        page?: number;
+        limit?: number;
+    }): Promise<{
+        totalCount: number;
+        list: UserLogsInfo[];
+    }>;
+    /**
+     * 查看审计日志
+     * @param options.operationNames  SupportedAdminActionEnum
+     */
+    listAuditLogs(options?: {
+        clientIp?: string;
+        operationNames?: string[];
+        operatorArns?: string[];
+        page?: number;
+        limit?: number;
+    }): Promise<{
+        list: AdminLogsInfo[];
+        totalCount: number;
+    }>;
+}

data/lib/authing_ruby/test/js_sdk_test/node_modules/authing-js-sdk/build/main/lib/management/StatisticsManagementClient.js

@@ -0,0 +1,198 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StatisticsManagementClient = void 0;
+/**
+ * @class StatisticsManagementClient 管理日志统计信息
+ * @name StatisticsManagementClient
+ * @description 管理日志统计信息
+ *
+ * @example
+ *
+ * 请使用以下方式使用该模块：
+ * \`\`\`javascript
+ * import { StatisticsManagementClient } from "authing-js-sdk"
+ * const managementClient = new ManagementClient({
+ *    userPoolId: "YOUR_USERPOOL_ID",
+ *    secret: "YOUR_USERPOOL_SECRET",
+ * })
+ * managementClient.statistics.listUserActions // 查看用户操作日志
+ * managementClient.statistics.listAuditLogs // 查看审计日志
+ * \`\`\`
+ *
+ */
+var StatisticsManagementClient = /** @class */ (function () {
+    function StatisticsManagementClient(options, httpClient, tokenProvider) {
+        this.options = options;
+        this.httpClient = httpClient;
+        this.tokenProvider = tokenProvider;
+    }
+    /**
+     * 查看用户操作日志
+     * @param options.operationNames SupportedUserActionEnum
+     */
+    StatisticsManagementClient.prototype.listUserActions = function (options) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function () {
+            var requestParam, result, list, totalCount;
+            var _this = this;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        requestParam = {};
+                        if (options === null || options === void 0 ? void 0 : options.clientIp) {
+                            requestParam.clientip = options.clientIp;
+                        }
+                        if (options === null || options === void 0 ? void 0 : options.operationNames) {
+                            requestParam.operation_name = options.operationNames;
+                        }
+                        if ((_a = options === null || options === void 0 ? void 0 : options.userIds) === null || _a === void 0 ? void 0 : _a.length) {
+                            requestParam.operator_arn = options.userIds.map(function (userId) {
+                                return "arn:cn:authing:" + _this.options.userPoolId + ":user:" + userId;
+                            });
+                        }
+                        if (options === null || options === void 0 ? void 0 : options.page) {
+                            requestParam.page = options.page;
+                        }
+                        if (options === null || options === void 0 ? void 0 : options.limit) {
+                            requestParam.limit = options.limit;
+                        }
+                        return [4 /*yield*/, this.httpClient.request({
+                                method: 'GET',
+                                url: this.options.host + "/api/v2/analysis/user-action",
+                                params: __assign({}, requestParam)
+                            })];
+                    case 1:
+                        result = _b.sent();
+                        list = result.list, totalCount = result.totalCount;
+                        return [2 /*return*/, {
+                                list: list.map(function (log) {
+                                    var _a, _b, _c, _d, _e, _f;
+                                    return {
+                                        userpoolId: log.userpool_id,
+                                        userId: (_a = log.user) === null || _a === void 0 ? void 0 : _a.id,
+                                        username: (_b = log.user) === null || _b === void 0 ? void 0 : _b.displayName,
+                                        cityName: (_c = log.geoip) === null || _c === void 0 ? void 0 : _c.city_name,
+                                        regionName: (_d = log.geoip) === null || _d === void 0 ? void 0 : _d.region_name,
+                                        clientIp: (_e = log.geoip) === null || _e === void 0 ? void 0 : _e.ip,
+                                        operationDesc: log.operation_desc,
+                                        operationName: log.operation_name,
+                                        timestamp: log.timestamp,
+                                        appId: log.app_id,
+                                        appName: (_f = log.app) === null || _f === void 0 ? void 0 : _f.name
+                                    };
+                                }),
+                                totalCount: totalCount
+                            }];
+                }
+            });
+        });
+    };
+    /**
+     * 查看审计日志
+     * @param options.operationNames  SupportedAdminActionEnum
+     */
+    StatisticsManagementClient.prototype.listAuditLogs = function (options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var requestParam, result, list, totalCount;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        requestParam = {};
+                        if (options === null || options === void 0 ? void 0 : options.clientIp) {
+                            requestParam.clientip = options.clientIp;
+                        }
+                        if (options === null || options === void 0 ? void 0 : options.operationNames) {
+                            requestParam.operation_name = options.operationNames;
+                        }
+                        if (options === null || options === void 0 ? void 0 : options.operatorArns) {
+                            requestParam.operator_arn = options.operatorArns;
+                        }
+                        if (options === null || options === void 0 ? void 0 : options.page) {
+                            requestParam.page = options.page;
+                        }
+                        if (options === null || options === void 0 ? void 0 : options.limit) {
+                            requestParam.limit = options.limit;
+                        }
+                        return [4 /*yield*/, this.httpClient.request({
+                                method: 'GET',
+                                url: this.options.host + "/api/v2/analysis/audit",
+                                params: __assign({}, requestParam)
+                            })];
+                    case 1:
+                        result = _a.sent();
+                        list = result.list, totalCount = result.totalCount;
+                        return [2 /*return*/, {
+                                list: list.map(function (log) {
+                                    var _a, _b, _c, _d, _e;
+                                    return {
+                                        userpoolId: log.userpool_id,
+                                        operatorType: log.operator_type,
+                                        operatorId: (_a = log.operator_detail) === null || _a === void 0 ? void 0 : _a.id,
+                                        operatorName: (_b = log.operator_detail) === null || _b === void 0 ? void 0 : _b.displayName,
+                                        operationName: log.operation_name,
+                                        cityName: (_c = log.geoip) === null || _c === void 0 ? void 0 : _c.city_name,
+                                        regionName: (_d = log.geoip) === null || _d === void 0 ? void 0 : _d.region_name,
+                                        clientIp: (_e = log.geoip) === null || _e === void 0 ? void 0 : _e.ip,
+                                        resourceType: log.resource_type,
+                                        resourceDesc: log.resource_desc,
+                                        resource_arn: log.resource_arn,
+                                        timestamp: log.timestamp
+                                    };
+                                }),
+                                totalCount: totalCount
+                            }];
+                }
+            });
+        });
+    };
+    return StatisticsManagementClient;
+}());
+exports.StatisticsManagementClient = StatisticsManagementClient;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiU3RhdGlzdGljc01hbmFnZW1lbnRDbGllbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvbGliL21hbmFnZW1lbnQvU3RhdGlzdGljc01hbmFnZW1lbnRDbGllbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFJQTs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBa0JHO0FBQ0g7SUFLRSxvQ0FDRSxPQUFnQyxFQUNoQyxVQUFzQixFQUN0QixhQUFzQztRQUV0QyxJQUFJLENBQUMsT0FBTyxHQUFHLE9BQU8sQ0FBQztRQUN2QixJQUFJLENBQUMsVUFBVSxHQUFHLFVBQVUsQ0FBQztRQUM3QixJQUFJLENBQUMsYUFBYSxHQUFHLGFBQWEsQ0FBQztJQUNyQyxDQUFDO0lBRUQ7OztPQUdHO0lBQ0csb0RBQWUsR0FBckIsVUFBc0IsT0FNckI7Ozs7Ozs7O3dCQUNLLFlBQVksR0FBUSxFQUFFLENBQUM7d0JBQzNCLElBQUksT0FBTyxhQUFQLE9BQU8sdUJBQVAsT0FBTyxDQUFFLFFBQVEsRUFBRTs0QkFDckIsWUFBWSxDQUFDLFFBQVEsR0FBRyxPQUFPLENBQUMsUUFBUSxDQUFDO3lCQUMxQzt3QkFDRCxJQUFJLE9BQU8sYUFBUCxPQUFPLHVCQUFQLE9BQU8sQ0FBRSxjQUFjLEVBQUU7NEJBQzNCLFlBQVksQ0FBQyxjQUFjLEdBQUcsT0FBTyxDQUFDLGNBQWMsQ0FBQzt5QkFDdEQ7d0JBQ0QsVUFBSSxPQUFPLGFBQVAsT0FBTyx1QkFBUCxPQUFPLENBQUUsT0FBTywwQ0FBRSxNQUFNLEVBQUU7NEJBQzVCLFlBQVksQ0FBQyxZQUFZLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsVUFBQSxNQUFNO2dDQUNwRCxPQUFPLG9CQUFrQixLQUFJLENBQUMsT0FBTyxDQUFDLFVBQVUsY0FBUyxNQUFRLENBQUM7NEJBQ3BFLENBQUMsQ0FBQyxDQUFDO3lCQUNKO3dCQUNELElBQUksT0FBTyxhQUFQLE9BQU8sdUJBQVAsT0FBTyxDQUFFLElBQUksRUFBRTs0QkFDakIsWUFBWSxDQUFDLElBQUksR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDO3lCQUNsQzt3QkFDRCxJQUFJLE9BQU8sYUFBUCxPQUFPLHVCQUFQLE9BQU8sQ0FBRSxLQUFLLEVBQUU7NEJBQ2xCLFlBQVksQ0FBQyxLQUFLLEdBQUcsT0FBTyxDQUFDLEtBQUssQ0FBQzt5QkFDcEM7d0JBQ21CLHFCQUFNLElBQUksQ0FBQyxVQUFVLENBQUMsT0FBTyxDQUFDO2dDQUNoRCxNQUFNLEVBQUUsS0FBSztnQ0FDYixHQUFHLEVBQUssSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLGlDQUE4QjtnQ0FDdkQsTUFBTSxlQUFPLFlBQVksQ0FBRTs2QkFDNUIsQ0FBQyxFQUFBOzt3QkFKSSxNQUFNLEdBQVEsU0FJbEI7d0JBQ00sSUFBSSxHQUFpQixNQUFNLEtBQXZCLEVBQUUsVUFBVSxHQUFLLE1BQU0sV0FBWCxDQUFZO3dCQUNwQyxzQkFBTztnQ0FDTCxJQUFJLEVBQUUsSUFBSSxDQUFDLEdBQUcsQ0FBQyxVQUFDLEdBQVE7O29DQUN0QixPQUFPO3dDQUNMLFVBQVUsRUFBRSxHQUFHLENBQUMsV0FBVzt3Q0FDM0IsTUFBTSxRQUFFLEdBQUcsQ0FBQyxJQUFJLDBDQUFFLEVBQUU7d0NBQ3BCLFFBQVEsUUFBRSxHQUFHLENBQUMsSUFBSSwwQ0FBRSxXQUFXO3dDQUMvQixRQUFRLFFBQUUsR0FBRyxDQUFDLEtBQUssMENBQUUsU0FBUzt3Q0FDOUIsVUFBVSxRQUFFLEdBQUcsQ0FBQyxLQUFLLDBDQUFFLFdBQVc7d0NBQ2xDLFFBQVEsUUFBRSxHQUFHLENBQUMsS0FBSywwQ0FBRSxFQUFFO3dDQUN2QixhQUFhLEVBQUUsR0FBRyxDQUFDLGNBQWM7d0NBQ2pDLGFBQWEsRUFBRSxHQUFHLENBQUMsY0FBYzt3Q0FDakMsU0FBUyxFQUFFLEdBQUcsQ0FBQyxTQUFTO3dDQUN4QixLQUFLLEVBQUUsR0FBRyxDQUFDLE1BQU07d0NBQ2pCLE9BQU8sUUFBRSxHQUFHLENBQUMsR0FBRywwQ0FBRSxJQUFJO3FDQUN2QixDQUFDO2dDQUNKLENBQUMsQ0FBQztnQ0FDRixVQUFVLFlBQUE7NkJBQ1gsRUFBQzs7OztLQUNIO0lBRUQ7OztPQUdHO0lBQ0csa0RBQWEsR0FBbkIsVUFBb0IsT0FNbkI7Ozs7Ozt3QkFDSyxZQUFZLEdBQVEsRUFBRSxDQUFDO3dCQUMzQixJQUFJLE9BQU8sYUFBUCxPQUFPLHVCQUFQLE9BQU8sQ0FBRSxRQUFRLEVBQUU7NEJBQ3JCLFlBQVksQ0FBQyxRQUFRLEdBQUcsT0FBTyxDQUFDLFFBQVEsQ0FBQzt5QkFDMUM7d0JBQ0QsSUFBSSxPQUFPLGFBQVAsT0FBTyx1QkFBUCxPQUFPLENBQUUsY0FBYyxFQUFFOzRCQUMzQixZQUFZLENBQUMsY0FBYyxHQUFHLE9BQU8sQ0FBQyxjQUFjLENBQUM7eUJBQ3REO3dCQUNELElBQUksT0FBTyxhQUFQLE9BQU8sdUJBQVAsT0FBTyxDQUFFLFlBQVksRUFBRTs0QkFDekIsWUFBWSxDQUFDLFlBQVksR0FBRyxPQUFPLENBQUMsWUFBWSxDQUFDO3lCQUNsRDt3QkFDRCxJQUFJLE9BQU8sYUFBUCxPQUFPLHVCQUFQLE9BQU8sQ0FBRSxJQUFJLEVBQUU7NEJBQ2pCLFlBQVksQ0FBQyxJQUFJLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQzt5QkFDbEM7d0JBQ0QsSUFBSSxPQUFPLGFBQVAsT0FBTyx1QkFBUCxPQUFPLENBQUUsS0FBSyxFQUFFOzRCQUNsQixZQUFZLENBQUMsS0FBSyxHQUFHLE9BQU8sQ0FBQyxLQUFLLENBQUM7eUJBQ3BDO3dCQUNtQixxQkFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLE9BQU8sQ0FBQztnQ0FDaEQsTUFBTSxFQUFFLEtBQUs7Z0NBQ2IsR0FBRyxFQUFLLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSwyQkFBd0I7Z0NBQ2pELE1BQU0sZUFBTyxZQUFZLENBQUU7NkJBQzVCLENBQUMsRUFBQTs7d0JBSkksTUFBTSxHQUFRLFNBSWxCO3dCQUNNLElBQUksR0FBaUIsTUFBTSxLQUF2QixFQUFFLFVBQVUsR0FBSyxNQUFNLFdBQVgsQ0FBWTt3QkFDcEMsc0JBQU87Z0NBQ0wsSUFBSSxFQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsVUFBQyxHQUFROztvQ0FDdEIsT0FBTzt3Q0FDTCxVQUFVLEVBQUUsR0FBRyxDQUFDLFdBQVc7d0NBQzNCLFlBQVksRUFBRSxHQUFHLENBQUMsYUFBYTt3Q0FDL0IsVUFBVSxRQUFFLEdBQUcsQ0FBQyxlQUFlLDBDQUFFLEVBQUU7d0NBQ25DLFlBQVksUUFBRSxHQUFHLENBQUMsZUFBZSwwQ0FBRSxXQUFXO3dDQUM5QyxhQUFhLEVBQUUsR0FBRyxDQUFDLGNBQWM7d0NBQ2pDLFFBQVEsUUFBRSxHQUFHLENBQUMsS0FBSywwQ0FBRSxTQUFTO3dDQUM5QixVQUFVLFFBQUUsR0FBRyxDQUFDLEtBQUssMENBQUUsV0FBVzt3Q0FDbEMsUUFBUSxRQUFFLEdBQUcsQ0FBQyxLQUFLLDBDQUFFLEVBQUU7d0NBQ3ZCLFlBQVksRUFBRSxHQUFHLENBQUMsYUFBYTt3Q0FDL0IsWUFBWSxFQUFFLEdBQUcsQ0FBQyxhQUFhO3dDQUMvQixZQUFZLEVBQUUsR0FBRyxDQUFDLFlBQVk7d0NBQzlCLFNBQVMsRUFBRSxHQUFHLENBQUMsU0FBUztxQ0FDekIsQ0FBQztnQ0FDSixDQUFDLENBQUM7Z0NBQ0YsVUFBVSxZQUFBOzZCQUNYLEVBQUM7Ozs7S0FDSDtJQUNILGlDQUFDO0FBQUQsQ0FBQyxBQTNIRCxJQTJIQztBQTNIWSxnRUFBMEIifQ==

data/lib/authing_ruby/test/js_sdk_test/node_modules/authing-js-sdk/build/main/lib/management/UdfManagementClient.d.ts

@@ -0,0 +1,146 @@
+import { GraphqlClient } from './../common/GraphqlClient';
+import { ManagementTokenProvider } from './ManagementTokenProvider';
+import { ManagementClientOptions } from './types';
+import { CommonMessage, UdfDataType, UdfTargetType, UserDefinedField, UserDefinedData } from '../../types/graphql.v2';
+/**
+ * @name UdfManagementClient
+ * @description Udf 是 User Defined Field（用户自定义字段） 的简称。Authing 的数据实体（如用户、角色、分组、组织机构等）可以添加自定义字段，你可以配置 Authing 默认不自带的字段，比如你需要创建以一个学校相关的应用，就可以添加一个自定义 \`school\` 字段。
+ * 同时你可以在用户注册完成之后要求用户补充此字段的信息，详细文档请见 https://docs.authing.co/extensibility/user/extend-register-fields.html 。
+ *
+ * 此模块可以用于对自定义字段元数据进行管理。
+ *
+ * @example
+ *
+ * 请使用以下方式使用该模块：
+ * \`\`\`javascript
+ * import { ManagementClient } from "authing-js-sdk"
+ * const managementClient = new ManagementClient({
+ *    userPoolId: "YOUR_USERPOOL_ID",
+ *    secret: "YOUR_USERPOOL_SECRET",
+ * })
+ * managementClient.udf.list // 获取自定义字段元数据列表
+ * managementClient.udf.set // 设置自定义字段
+ * managementClient.udf.remove // 删除自定义字段
+ * \`\`\`
+ *
+ * @class UdfManagementClient 管理自定义字段元数据
+ */
+export declare class UdfManagementClient {
+    options: ManagementClientOptions;
+    graphqlClient: GraphqlClient;
+    tokenProvider: ManagementTokenProvider;
+    constructor(options: ManagementClientOptions, graphqlClient: GraphqlClient, tokenProvider: ManagementTokenProvider);
+    /**
+     * @name set
+     * @name_zh 设置自定义字段元数据
+     * @description 设置自定义字段元数据，如果该字段不存在会自动创建。
+     *
+     * @param {UdfTargetType} targetType 自定义字段目标类型， USER 表示用户、ROLE 表示角色。
+     * @param {string} key 字段 key
+     * @param {UdfDataType} dataType 数据类型，目前共支持五种数据类型。STRING 为字符串、NUMBER 为数字、DATETIME 为日期、BOOLEAN 为 boolean 值、OBJECT 为对象。
+     * @param {string} label 字段 Label，一般是一个 Human Readable 字符串。
+     *
+     * @example
+     *
+     * import { ManagementClient, UdfTargetType, UdfDataType  } from "authing-js-sdk"
+     * const udf = await managementClient.udf.set(
+     *    UdfTargetType.User,
+     *    'school',
+     *    UdfDataType.String,
+     *    '学校'
+     * );
+     *
+     * @example
+     *
+     * // 如果 age 这个自定义字段不存在，第一次会创建
+     *
+     * import { ManagementClient, UdfTargetType, UdfDataType  } from "authing-js-sdk"
+     * const udf = await managementClient.udf.set(
+     *    UdfTargetType.User,
+     *    'age',
+     *    UdfDataType.Number,
+     *    '年龄'
+     * );
+     *
+     * // 如果 age 字段之前创建过，会修改该字段的配置
+     *
+     * const udf = await managementClient.udf.set(
+     *    UdfTargetType.User,
+     *    'age',
+     *    UdfDataType.Number,
+     *    '新的描述信息'
+     * );
+     *
+     * @returns {Promise<UserDefinedField[]>}
+     * @memberof UdfManagementClient
+     */
+    set(targetType: UdfTargetType, key: string, dataType: UdfDataType, label: string): Promise<UserDefinedField>;
+    /**
+     * @name remove
+     * @name_zh 删除自定义字段
+     * @description 删除自定义字段
+     *
+     * @param {UdfTargetType} targetType 自定义字段目标类型， USER 表示用户、ROLE 表示角色。
+     * @param {string} key 字段 key
+     *
+     * @example
+     *
+     * await managementClient.udf.remove(UdfTargetType.User, 'school');
+     *
+     * @returns {Promise<UserDefinedField[]>}
+     * @memberof UdfManagementClient
+     */
+    remove(targetType: UdfTargetType, key: string): Promise<CommonMessage>;
+    /**
+     * @name list
+     * @name_zh 获取自定义字段定义
+     * @description 查询用户池定义的自定义字段
+     *
+     * @param {UdfTargetType} targetType 自定义字段目标类型， USER 表示用户、ROLE 表示角色。
+     * @example
+     *
+     * const list = await managementClient.udf.list(UdfTargetType.User);
+     *
+     * @returns {Promise<UserDefinedField[]>}
+     * @memberof UdfManagementClient
+     */
+    list(targetType: UdfTargetType): Promise<UserDefinedField[]>;
+    /**
+     * @name listUdv
+     * @name_zh 获取某一实体的自定义字段数据列表
+     * @description 获取某一实体的自定义字段数据列表
+     *
+     *
+     * @param {UdfTargetType} targetType 自定义字段目标类型， USER 表示用户、ROLE 表示角色。
+     * @param {string} targetId 自定义字段目标 id，如用户 ID
+     * @example
+     *
+     * udfManagementClient.listUdv('USER', 'userId')
+     *
+     * @returns {Promise<Array<UserDefinedData>>}
+     * @memberof UdfManagementClient
+     */
+    listUdv(targetType: UdfTargetType, targetId: string): Promise<Array<UserDefinedData>>;
+    /**
+     * @name setUdvBatch
+     * @name_zh 批量添加自定义数据
+     * @description 批量添加自定义数据
+     *
+     * @param {UdfTargetType} targetType 自定义字段目标类型， USER 表示用户、ROLE 表示角色。
+     * @param {string} targetId 自定义字段目标 id，如用户 ID
+     * @param {Object[]} [udvList]
+     * @param {boolean} [udvList.key] 自定义字段的 key
+     * @param {string} [udvList.value] 自定义字段的值
+     *
+     * @example
+     *
+     * udfManagementClient.setUdv('USER', 'userId', [{key: 'school', 'value': '清华大学'}])
+     *
+     * @returns {Promise<Array<UserDefinedData>>}
+     * @memberof UdfManagementClient
+     */
+    setUdvBatch(targetType: UdfTargetType, targetId: string, udvList: {
+        key: string;
+        value: any;
+    }[]): Promise<Array<UserDefinedData>>;
+}

data/lib/authing_ruby/test/js_sdk_test/node_modules/authing-js-sdk/build/main/lib/management/UdfManagementClient.js

@@ -0,0 +1,264 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UdfManagementClient = void 0;
+var graphqlapi_1 = require("../graphqlapi");
+var utils_1 = require("../utils");
+/**
+ * @name UdfManagementClient
+ * @description Udf 是 User Defined Field（用户自定义字段） 的简称。Authing 的数据实体（如用户、角色、分组、组织机构等）可以添加自定义字段，你可以配置 Authing 默认不自带的字段，比如你需要创建以一个学校相关的应用，就可以添加一个自定义 \`school\` 字段。
+ * 同时你可以在用户注册完成之后要求用户补充此字段的信息，详细文档请见 https://docs.authing.co/extensibility/user/extend-register-fields.html 。
+ *
+ * 此模块可以用于对自定义字段元数据进行管理。
+ *
+ * @example
+ *
+ * 请使用以下方式使用该模块：
+ * \`\`\`javascript
+ * import { ManagementClient } from "authing-js-sdk"
+ * const managementClient = new ManagementClient({
+ *    userPoolId: "YOUR_USERPOOL_ID",
+ *    secret: "YOUR_USERPOOL_SECRET",
+ * })
+ * managementClient.udf.list // 获取自定义字段元数据列表
+ * managementClient.udf.set // 设置自定义字段
+ * managementClient.udf.remove // 删除自定义字段
+ * \`\`\`
+ *
+ * @class UdfManagementClient 管理自定义字段元数据
+ */
+var UdfManagementClient = /** @class */ (function () {
+    function UdfManagementClient(options, graphqlClient, tokenProvider) {
+        this.options = options;
+        this.graphqlClient = graphqlClient;
+        this.tokenProvider = tokenProvider;
+    }
+    /**
+     * @name set
+     * @name_zh 设置自定义字段元数据
+     * @description 设置自定义字段元数据，如果该字段不存在会自动创建。
+     *
+     * @param {UdfTargetType} targetType 自定义字段目标类型， USER 表示用户、ROLE 表示角色。
+     * @param {string} key 字段 key
+     * @param {UdfDataType} dataType 数据类型，目前共支持五种数据类型。STRING 为字符串、NUMBER 为数字、DATETIME 为日期、BOOLEAN 为 boolean 值、OBJECT 为对象。
+     * @param {string} label 字段 Label，一般是一个 Human Readable 字符串。
+     *
+     * @example
+     *
+     * import { ManagementClient, UdfTargetType, UdfDataType  } from "authing-js-sdk"
+     * const udf = await managementClient.udf.set(
+     *    UdfTargetType.User,
+     *    'school',
+     *    UdfDataType.String,
+     *    '学校'
+     * );
+     *
+     * @example
+     *
+     * // 如果 age 这个自定义字段不存在，第一次会创建
+     *
+     * import { ManagementClient, UdfTargetType, UdfDataType  } from "authing-js-sdk"
+     * const udf = await managementClient.udf.set(
+     *    UdfTargetType.User,
+     *    'age',
+     *    UdfDataType.Number,
+     *    '年龄'
+     * );
+     *
+     * // 如果 age 字段之前创建过，会修改该字段的配置
+     *
+     * const udf = await managementClient.udf.set(
+     *    UdfTargetType.User,
+     *    'age',
+     *    UdfDataType.Number,
+     *    '新的描述信息'
+     * );
+     *
+     * @returns {Promise<UserDefinedField[]>}
+     * @memberof UdfManagementClient
+     */
+    UdfManagementClient.prototype.set = function (targetType, key, dataType, label) {
+        return __awaiter(this, void 0, void 0, function () {
+            var data;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, graphqlapi_1.setUdf(this.graphqlClient, this.tokenProvider, {
+                            targetType: targetType,
+                            dataType: dataType,
+                            key: key,
+                            label: label
+                        })];
+                    case 1:
+                        data = (_a.sent()).setUdf;
+                        return [2 /*return*/, data];
+                }
+            });
+        });
+    };
+    /**
+     * @name remove
+     * @name_zh 删除自定义字段
+     * @description 删除自定义字段
+     *
+     * @param {UdfTargetType} targetType 自定义字段目标类型， USER 表示用户、ROLE 表示角色。
+     * @param {string} key 字段 key
+     *
+     * @example
+     *
+     * await managementClient.udf.remove(UdfTargetType.User, 'school');
+     *
+     * @returns {Promise<UserDefinedField[]>}
+     * @memberof UdfManagementClient
+     */
+    UdfManagementClient.prototype.remove = function (targetType, key) {
+        return __awaiter(this, void 0, void 0, function () {
+            var list;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, graphqlapi_1.removeUdf(this.graphqlClient, this.tokenProvider, {
+                            targetType: targetType,
+                            key: key
+                        })];
+                    case 1:
+                        list = (_a.sent()).removeUdf;
+                        return [2 /*return*/, list];
+                }
+            });
+        });
+    };
+    /**
+     * @name list
+     * @name_zh 获取自定义字段定义
+     * @description 查询用户池定义的自定义字段
+     *
+     * @param {UdfTargetType} targetType 自定义字段目标类型， USER 表示用户、ROLE 表示角色。
+     * @example
+     *
+     * const list = await managementClient.udf.list(UdfTargetType.User);
+     *
+     * @returns {Promise<UserDefinedField[]>}
+     * @memberof UdfManagementClient
+     */
+    UdfManagementClient.prototype.list = function (targetType) {
+        return __awaiter(this, void 0, void 0, function () {
+            var list;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, graphqlapi_1.udf(this.graphqlClient, this.tokenProvider, {
+                            targetType: targetType
+                        })];
+                    case 1:
+                        list = (_a.sent()).udf;
+                        return [2 /*return*/, list];
+                }
+            });
+        });
+    };
+    /**
+     * @name listUdv
+     * @name_zh 获取某一实体的自定义字段数据列表
+     * @description 获取某一实体的自定义字段数据列表
+     *
+     *
+     * @param {UdfTargetType} targetType 自定义字段目标类型， USER 表示用户、ROLE 表示角色。
+     * @param {string} targetId 自定义字段目标 id，如用户 ID
+     * @example
+     *
+     * udfManagementClient.listUdv('USER', 'userId')
+     *
+     * @returns {Promise<Array<UserDefinedData>>}
+     * @memberof UdfManagementClient
+     */
+    UdfManagementClient.prototype.listUdv = function (targetType, targetId) {
+        return __awaiter(this, void 0, void 0, function () {
+            var list;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, graphqlapi_1.udv(this.graphqlClient, this.tokenProvider, {
+                            targetType: targetType,
+                            targetId: targetId
+                        })];
+                    case 1:
+                        list = (_a.sent()).udv;
+                        return [2 /*return*/, utils_1.convertUdv(list)];
+                }
+            });
+        });
+    };
+    /**
+     * @name setUdvBatch
+     * @name_zh 批量添加自定义数据
+     * @description 批量添加自定义数据
+     *
+     * @param {UdfTargetType} targetType 自定义字段目标类型， USER 表示用户、ROLE 表示角色。
+     * @param {string} targetId 自定义字段目标 id，如用户 ID
+     * @param {Object[]} [udvList]
+     * @param {boolean} [udvList.key] 自定义字段的 key
+     * @param {string} [udvList.value] 自定义字段的值
+     *
+     * @example
+     *
+     * udfManagementClient.setUdv('USER', 'userId', [{key: 'school', 'value': '清华大学'}])
+     *
+     * @returns {Promise<Array<UserDefinedData>>}
+     * @memberof UdfManagementClient
+     */
+    UdfManagementClient.prototype.setUdvBatch = function (targetType, targetId, udvList) {
+        return __awaiter(this, void 0, void 0, function () {
+            var list;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, graphqlapi_1.setUdvBatch(this.graphqlClient, this.tokenProvider, {
+                            targetType: targetType,
+                            targetId: targetId,
+                            udvList: udvList.map(function (item) { return ({
+                                key: item.key,
+                                value: JSON.stringify(item.value)
+                            }); })
+                        })];
+                    case 1:
+                        list = (_a.sent()).setUdvBatch;
+                        return [2 /*return*/, utils_1.convertUdv(list)];
+                }
+            });
+        });
+    };
+    return UdfManagementClient;
+}());
+exports.UdfManagementClient = UdfManagementClient;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVWRmTWFuYWdlbWVudENsaWVudC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvbWFuYWdlbWVudC9VZGZNYW5hZ2VtZW50Q2xpZW50LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQVVBLDRDQUF5RTtBQUN6RSxrQ0FBc0M7QUFFdEM7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0FzQkc7QUFDSDtJQUtFLDZCQUNFLE9BQWdDLEVBQ2hDLGFBQTRCLEVBQzVCLGFBQXNDO1FBRXRDLElBQUksQ0FBQyxPQUFPLEdBQUcsT0FBTyxDQUFDO1FBQ3ZCLElBQUksQ0FBQyxhQUFhLEdBQUcsYUFBYSxDQUFDO1FBQ25DLElBQUksQ0FBQyxhQUFhLEdBQUcsYUFBYSxDQUFDO0lBQ3JDLENBQUM7SUFFRDs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztPQTJDRztJQUNHLGlDQUFHLEdBQVQsVUFDRSxVQUF5QixFQUN6QixHQUFXLEVBQ1gsUUFBcUIsRUFDckIsS0FBYTs7Ozs7NEJBRVkscUJBQU0sbUJBQU0sQ0FDbkMsSUFBSSxDQUFDLGFBQWEsRUFDbEIsSUFBSSxDQUFDLGFBQWEsRUFDbEI7NEJBQ0UsVUFBVSxZQUFBOzRCQUNWLFFBQVEsVUFBQTs0QkFDUixHQUFHLEtBQUE7NEJBQ0gsS0FBSyxPQUFBO3lCQUNOLENBQ0YsRUFBQTs7d0JBVGUsSUFBSSxHQUFLLENBQUEsU0FTeEIsQ0FBQSxPQVRtQjt3QkFVcEIsc0JBQU8sSUFBSSxFQUFDOzs7O0tBQ2I7SUFFRDs7Ozs7Ozs7Ozs7Ozs7T0FjRztJQUNHLG9DQUFNLEdBQVosVUFBYSxVQUF5QixFQUFFLEdBQVc7Ozs7OzRCQUNyQixxQkFBTSxzQkFBUyxDQUN6QyxJQUFJLENBQUMsYUFBYSxFQUNsQixJQUFJLENBQUMsYUFBYSxFQUNsQjs0QkFDRSxVQUFVLFlBQUE7NEJBQ1YsR0FBRyxLQUFBO3lCQUNKLENBQ0YsRUFBQTs7d0JBUGtCLElBQUksR0FBSyxDQUFBLFNBTzNCLENBQUEsVUFQc0I7d0JBUXZCLHNCQUFPLElBQUksRUFBQzs7OztLQUNiO0lBRUQ7Ozs7Ozs7Ozs7OztPQVlHO0lBQ0csa0NBQUksR0FBVixVQUFXLFVBQXlCOzs7Ozs0QkFDWixxQkFBTSxnQkFBRyxDQUFDLElBQUksQ0FBQyxhQUFhLEVBQUUsSUFBSSxDQUFDLGFBQWEsRUFBRTs0QkFDdEUsVUFBVSxZQUFBO3lCQUNYLENBQUMsRUFBQTs7d0JBRlcsSUFBSSxHQUFLLENBQUEsU0FFcEIsQ0FBQSxJQUZlO3dCQUdqQixzQkFBTyxJQUFJLEVBQUM7Ozs7S0FDYjtJQUVEOzs7Ozs7Ozs7Ozs7OztPQWNHO0lBQ0cscUNBQU8sR0FBYixVQUNFLFVBQXlCLEVBQ3pCLFFBQWdCOzs7Ozs0QkFFTSxxQkFBTSxnQkFBRyxDQUFDLElBQUksQ0FBQyxhQUFhLEVBQUUsSUFBSSxDQUFDLGFBQWEsRUFBRTs0QkFDdEUsVUFBVSxZQUFBOzRCQUNWLFFBQVEsVUFBQTt5QkFDVCxDQUFDLEVBQUE7O3dCQUhXLElBQUksR0FBSyxDQUFBLFNBR3BCLENBQUEsSUFIZTt3QkFJakIsc0JBQU8sa0JBQVUsQ0FBQyxJQUFJLENBQUMsRUFBQzs7OztLQUN6QjtJQUVEOzs7Ozs7Ozs7Ozs7Ozs7OztPQWlCRztJQUNHLHlDQUFXLEdBQWpCLFVBQ0UsVUFBeUIsRUFDekIsUUFBZ0IsRUFDaEIsT0FHRzs7Ozs7NEJBRTJCLHFCQUFNLHdCQUFXLENBQzdDLElBQUksQ0FBQyxhQUFhLEVBQ2xCLElBQUksQ0FBQyxhQUFhLEVBQ2xCOzRCQUNFLFVBQVUsWUFBQTs0QkFDVixRQUFRLFVBQUE7NEJBQ1IsT0FBTyxFQUFFLE9BQU8sQ0FBQyxHQUFHLENBQUMsVUFBQSxJQUFJLElBQUksT0FBQSxDQUFDO2dDQUM1QixHQUFHLEVBQUUsSUFBSSxDQUFDLEdBQUc7Z0NBQ2IsS0FBSyxFQUFFLElBQUksQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQzs2QkFDbEMsQ0FBQyxFQUgyQixDQUczQixDQUFDO3lCQUNKLENBQ0YsRUFBQTs7d0JBWG9CLElBQUksR0FBSyxDQUFBLFNBVzdCLENBQUEsWUFYd0I7d0JBWXpCLHNCQUFPLGtCQUFVLENBQUMsSUFBSSxDQUFDLEVBQUM7Ozs7S0FDekI7SUFDSCwwQkFBQztBQUFELENBQUMsQUEvTEQsSUErTEM7QUEvTFksa0RBQW1CIn0=