smartbi-toolkit 1.1.3 → 1.1.4

package/dist/methods/UserManagerService.js

@@ -0,0 +1,312 @@
+import { smartbi } from "../index";
+/**
+ * 创建用户
+ * @param parentGroupId 父组ID
+ * @param userName 用户名
+ * @param userAlias 用户别名
+ * @param desc 描述
+ * @param password 密码
+ * @param isEnabled 是否启用
+ * @param forceChangePassword 是否强制修改密码(可选)
+ * @returns 返回新创建的用户ID
+ */
+export const createUser = (parentGroupId, userName, userAlias, desc, password, isEnabled, forceChangePassword) => {
+    const params = forceChangePassword !== undefined
+        ? [parentGroupId, userName, userAlias, desc, password, isEnabled, forceChangePassword]
+        : [parentGroupId, userName, userAlias, desc, password, isEnabled];
+    return smartbi('UserManagerService', 'createUser', params);
+};
+/**
+ * 指定ID创建用户
+ * @param parentGroupId 父组ID
+ * @param userId 用户ID
+ * @param userName 用户名
+ * @param userAlias 用户别名
+ * @param desc 描述
+ * @param password 密码
+ * @param isEnabled 是否启用
+ * @param forceChangePassword 是否强制修改密码(可选)
+ */
+export const createUserById = (parentGroupId, userId, userName, userAlias, desc, password, isEnabled, forceChangePassword) => {
+    const params = forceChangePassword !== undefined
+        ? [parentGroupId, userId, userName, userAlias, desc, password, isEnabled, forceChangePassword]
+        : [parentGroupId, userId, userName, userAlias, desc, password, isEnabled];
+    return smartbi('UserManagerService', 'createUserById', params);
+};
+/**
+ * 删除用户
+ * @param userId 用户ID
+ * @returns 返回是否删除成功的布尔值
+ */
+export const deleteUser = (userId) => {
+    return smartbi('UserManagerService', 'deleteUser', [userId]);
+};
+/**
+ * 通过用户ID获取用户信息
+ * @param id 用户ID
+ * @returns 返回用户信息
+ */
+export const getUserById = (id) => {
+    return smartbi('UserManagerService', 'getUserById', [id]);
+};
+/**
+ * 通过用户名称获取用户信息
+ * @param name 用户名称
+ * @returns 返回用户信息
+ */
+export const getUserByName = (name) => {
+    return smartbi('UserManagerService', 'getUserByName', [name]);
+};
+/**
+ * 根据用户扩展属性获取用户信息
+ * @param key 属性键
+ * @param value 属性值
+ * @returns 返回用户列表
+ */
+export const getUserByAttribute = (key, value) => {
+    return smartbi('UserManagerService', 'getUserByAttribute', [key, value]);
+};
+/**
+ * 获取系统中的用户列表
+ * @returns 返回用户列表
+ */
+export const getAllUsers = () => {
+    return smartbi('UserManagerService', 'getAllUsers', []);
+};
+/**
+ * 获取当前登录用户信息
+ * @returns 返回当前用户信息
+ */
+export const getCurrentUser = () => {
+    return smartbi('UserManagerService', 'getCurrentUser', []);
+};
+/**
+ * 修改当前用户的密码
+ * @param oldPassword 旧密码
+ * @param newPassword 新密码
+ */
+export const changePassword = (oldPassword, newPassword) => {
+    return smartbi('UserManagerService', 'changePassword', [oldPassword, newPassword]);
+};
+/**
+ * 获取用户密码
+ * @param userName 用户名
+ * @returns 返回用户密码
+ */
+export const getPassword = (userName) => {
+    return smartbi('UserManagerService', 'getPassword', [userName]);
+};
+/**
+ * 创建角色
+ * @param roleName 角色名称
+ * @param roleAlias 角色别名
+ * @param desc 描述
+ * @param groupId 组ID
+ * @returns 返回新创建的角色ID
+ */
+export const createRole = (roleName, roleAlias, desc, groupId) => {
+    return smartbi('UserManagerService', 'createRole', [roleName, roleAlias, desc, groupId]);
+};
+/**
+ * 删除角色
+ * @param roleId 角色ID
+ * @returns 返回是否删除成功的布尔值
+ */
+export const deleteRole = (roleId) => {
+    return smartbi('UserManagerService', 'deleteRole', [roleId]);
+};
+/**
+ * 通过ID获取角色
+ * @param id 角色ID
+ * @returns 返回角色信息
+ */
+export const getRoleById = (id) => {
+    return smartbi('UserManagerService', 'getRoleById', [id]);
+};
+/**
+ * 通过角色名称获取角色对象
+ * @param name 角色名称
+ * @returns 返回角色信息
+ */
+export const getRoleByName = (name) => {
+    return smartbi('UserManagerService', 'getRoleByName', [name]);
+};
+/**
+ * 获取系统中的角色列表
+ * @returns 返回角色列表
+ */
+export const getAllRoles = () => {
+    return smartbi('UserManagerService', 'getAllRoles', []);
+};
+/**
+ * 给用户分配角色
+ * @param userId 用户ID
+ * @param roleIdList 角色ID列表
+ * @returns 返回是否分配成功的布尔值
+ */
+export const assignRolesToUser = (userId, roleIdList) => {
+    return smartbi('UserManagerService', 'assignRolesToUser', [userId, roleIdList.toString()]);
+};
+/**
+ * 给角色分配用户
+ * @param roleId 角色ID
+ * @param userIdList 用户ID列表
+ * @returns 返回是否分配成功的布尔值
+ */
+export const assignUsersToRole = (roleId, userIdList) => {
+    return smartbi('UserManagerService', 'assignUsersToRole', [roleId, userIdList.toString()]);
+};
+/**
+ * 创建组
+ * @param parentGroupId 父组ID
+ * @param groupName 组名称
+ * @param groupAlias 组别名
+ * @param desc 描述
+ * @param departmentCode 组编号
+ * @returns 返回新创建的组ID
+ */
+export const createDepartment = (parentGroupId, groupName, groupAlias, desc, departmentCode) => {
+    return smartbi('UserManagerService', 'createDepartment', [parentGroupId, groupName, groupAlias, desc, departmentCode]);
+};
+/**
+ * 删除组
+ * @param groupId 组ID
+ * @returns 返回是否删除成功的布尔值
+ */
+export const deleteDepartment = (groupId) => {
+    return smartbi('UserManagerService', 'deleteDepartment', [groupId]);
+};
+/**
+ * 通过ID获取组对象
+ * @param id 组ID
+ * @returns 返回组信息
+ */
+export const getDepartmentById = (id) => {
+    return smartbi('UserManagerService', 'getDepartmentById', [id]);
+};
+/**
+ * 通过组名称获取组对象
+ * @param name 组名称
+ * @returns 返回组信息
+ */
+export const getDepartmentByName = (name) => {
+    return smartbi('UserManagerService', 'getDepartmentByName', [name]);
+};
+/**
+ * 通过组编号获取组对象
+ * @param code 组编号
+ * @returns 返回组信息
+ */
+export const getDepartmentByCode = (code) => {
+    return smartbi('UserManagerService', 'getDepartmentByCode', [code]);
+};
+/**
+ * 获取系统中的组列表
+ * @returns 返回组列表
+ */
+export const getAllDepartments = () => {
+    return smartbi('UserManagerService', 'getAllDepartments', []);
+};
+/**
+ * 获取用户的所属组
+ * @param userId 用户ID
+ * @returns 返回用户所属组列表
+ */
+export const getDepartmentsOfUser = (userId) => {
+    return smartbi('UserManagerService', 'getDepartmentsOfUser', [userId]);
+};
+/**
+ * 修改组所拥有的用户
+ * @param groupId 组ID
+ * @param userIdList 用户ID列表
+ * @returns 返回是否修改成功的布尔值
+ */
+export const assignUsersToGroup = (groupId, userIdList) => {
+    return smartbi('UserManagerService', 'assignUsersToGroup', [groupId, userIdList.toString()]);
+};
+/**
+ * 修改用户的所属组
+ * @param userId 用户ID
+ * @param groupId 组ID列表
+ * @returns 返回是否修改成功的布尔值
+ */
+export const assignDepartmentsToUser = (userId, groupId) => {
+    return smartbi('UserManagerService', 'assignDepartmentsToUser', [userId, groupId.toString()]);
+};
+/**
+ * 添加扩展属性
+ * @param userId 用户ID
+ * @param key 属性键
+ * @param value 属性值
+ * @param longValue 长值
+ * @returns 返回是否添加成功的布尔值
+ */
+export const addUserAttribute = (userId, key, value, longValue) => {
+    return smartbi('UserManagerService', 'addUserAttribute', [userId, key, value, longValue]);
+};
+/**
+ * 获取指定的属性值
+ * @param userId 用户ID
+ * @param key 属性键
+ * @returns 返回扩展属性
+ */
+export const getUserAttribute = (userId, key) => {
+    return smartbi('UserManagerService', 'getUserAttribute', [userId, key]);
+};
+/**
+ * 获取某用户所有的属性值
+ * @param userId 用户ID
+ * @returns 返回用户所有扩展属性列表
+ */
+export const getAllUserAttributes = (userId) => {
+    return smartbi('UserManagerService', 'getAllUserAttributes', [userId]);
+};
+/**
+ * 创建操作权限
+ * @param funcId 权限ID
+ * @param parentFuncId 父权限ID
+ * @param funcName 权限名称
+ * @param funcAlias 权限别名
+ * @param funcDesc 权限描述
+ * @returns 返回是否创建成功的布尔值
+ */
+export const createFunction = (funcId, parentFuncId, funcName, funcAlias, funcDesc) => {
+    return smartbi('UserManagerService', 'createFunction', [funcId, parentFuncId, funcName, funcAlias, funcDesc]);
+};
+/**
+ * 删除操作权限
+ * @param funcId 权限ID
+ * @returns 返回是否删除成功的布尔值
+ */
+export const deleteFunction = (funcId) => {
+    return smartbi('UserManagerService', 'deleteFunction', [funcId]);
+};
+/**
+ * 通过操作权限ID获取操作权限对象
+ * @param funcId 权限ID
+ * @returns 返回权限信息
+ */
+export const getFunctionById = (funcId) => {
+    return smartbi('UserManagerService', 'getFunctionById', [funcId]);
+};
+/**
+ * 获取所有操作权限列表
+ * @returns 返回权限列表
+ */
+export const getAllFunctions = () => {
+    return smartbi('UserManagerService', 'getAllFunctions', []);
+};
+/**
+ * 获取License中的关键信息
+ * @returns 返回License信息
+ */
+export const getLicenseInfo = () => {
+    return smartbi('UserManagerService', 'getLicenseInfo', []);
+};
+/**
+ * 获取系统中所有License模块名称列表
+ * @returns 返回License模块名称列表
+ */
+export const getLicenses = () => {
+    return smartbi('UserManagerService', 'getLicenses', []);
+};

package/dist/types.d.ts

@@ -0,0 +1,412 @@
+export interface IResult {
+    cells: Array<any>;
+    axes: Array<any>;
+    [key: string]: any;
+}
+export interface RunningInfoItem {
+    name: string;
+    startTime: number;
+    cost: number;
+}
+export interface RunningInfo {
+    currentItem: RunningInfoItem;
+    currentItemFinished: boolean;
+    allItems: RunningInfoItem[];
+    asyncInfos: RunningInfo[];
+    resId?: string;
+    startTime: number;
+    isFinished: boolean;
+}
+export interface IParameter {
+    id: string;
+    name: string;
+    [key: string]: any;
+}
+export interface Parameter {
+    id: string;
+    name: string;
+    alias?: string;
+    desc?: string;
+    type?: string;
+    defaultValue?: string;
+    componentType?: string;
+    displayValue?: string;
+    value?: string;
+}
+export interface NameValuePair {
+    name: string;
+    value: string;
+    [key: string]: any;
+}
+export interface ViewMetaData {
+    clientId?: string;
+    totalRowCount: number;
+    fieldNames: string[];
+    fieldTypes: string[];
+}
+export type PropertyName = 'alias' | 'desc' | 'dataType' | 'dataFormat' | 'orderby' | 'transformRule';
+export declare const PropertyName: {
+    ALIAS: string;
+    DESC: string;
+    DATA_TYPE: string;
+    DATA_FORMAT: string;
+    ORDER_BY: string;
+    TRANSFORM_RULE: string;
+};
+export type BusinessViewType = 'RAW_SQL_QUERY' | 'VISUAL_QUERY' | 'SQL_QUERY';
+export declare const BusinessViewType: {
+    RAW_SQL_QUERY: string;
+    VISUAL_QUERY: string;
+    SQL_QUERY: string;
+};
+export interface CatalogElement {
+    id: string;
+    name: string;
+    alias: string;
+    desc?: string;
+    type: string;
+    hasChild: boolean;
+    order: number;
+    extended?: string;
+    hiddenInBrowse: boolean;
+    showOnPC: boolean;
+    showOnPad: boolean;
+    showOnPhone: boolean;
+    customImage?: string;
+    customMobileImage?: string;
+    mobileImageId?: string;
+    detectChild: boolean;
+    lastModifiedDate?: Date;
+    fullPath?: string;
+    parentId?: string;
+    [key: string]: any;
+}
+export interface ResourcePermission {
+    permissions: ResourcePermissionItem[];
+    inherited: boolean;
+    owner: IAssignee;
+    resid: string;
+    [key: string]: any;
+}
+export interface ICatalogSearchResult {
+    catalogElement?: any;
+    idPath?: string[];
+    aliasPath?: string[];
+}
+export type AccessType = 'REF' | 'READ' | 'WRITE';
+export declare const AccessType: {
+    REF: string;
+    READ: string;
+    WRITE: string;
+};
+export type CatalogElementType = 'FOLDER' | 'SIMPLE_REPORT' | 'ANALYSIS_REPORT' | 'COMBINED_QUERY' | 'INSIGHT' | 'OLAP_REPORT' | 'DASHBOARD' | 'SMARTBIX_PAGE' | 'DATASET' | 'VISUAL' | 'SQL' | 'PROCEDURE' | 'NATIVE_SQL' | 'JAVA' | 'SMARTBIX_DATASET' | 'AUGMENTED_DATASET' | 'BUSINESS_VIEW' | 'BUSINESS_SUBJECT' | 'BUSINESS_QUERY' | 'SPREADSHEET_REPORT' | 'WEB_SPREADSHEET_REPORT' | 'SMARTBI_DATAPROCESS' | 'ETL_AUTOMATION' | 'JOB_FLOW' | 'SMARTBI_MINING' | 'URL' | 'excelimport' | 'TXTQUERYOBJECT' | 'TXTDATASOURCE' | 'SCHEMA' | 'OLD_DATASET';
+export declare const CatalogElementType: {
+    FOLDER: string;
+    SIMPLE_REPORT: string;
+    ANALYSIS_REPORT: string;
+    COMBINED_QUERY: string;
+    INSIGHT: string;
+    OLAP_REPORT: string;
+    DASHBOARD: string;
+    SMARTBIX_PAGE: string;
+    DATASET: string;
+    VISUAL: string;
+    SQL: string;
+    PROCEDURE: string;
+    NATIVE_SQL: string;
+    JAVA: string;
+    SMARTBIX_DATASET: string;
+    AUGMENTED_DATASET: string;
+    BUSINESS_VIEW: string;
+    BUSINESS_SUBJECT: string;
+    BUSINESS_QUERY: string;
+    SPREADSHEET_REPORT: string;
+    WEB_SPREADSHEET_REPORT: string;
+    DATA_PROCESS: string;
+    ETL_AUTOMATION: string;
+    JOB_FLOW: string;
+    DATA_MINING: string;
+    URL_LINK: string;
+    EXCEL_IMPORT_TEMPLATE: string;
+    TXT_QUERY_OBJECT: string;
+    TXT_DATA_SOURCE: string;
+    SCHEMA: string;
+    OLD_DATASET: string;
+};
+export interface IAssignee {
+    id: string;
+    name: string;
+    alias: string;
+    type: string;
+}
+export interface ResourcePermissionItem {
+    assignee: IAssignee;
+    purviewType: string;
+    permissionApplyToScope: string;
+    groupDescend: boolean;
+    id: string;
+    fromresid: string;
+    expiresTime: string;
+    sourceUser?: any;
+}
+export type PermissionType = 'NONE' | 'REF' | 'READ' | 'WRITE' | 'OVERVIEW' | 'GRANT';
+export type PermissionDescendType = 'NONE' | 'FOLDER_ONLY' | 'FILE_ONLY' | 'FOLDER_FILE';
+export type HiddenInBrowse = boolean;
+export interface IClientCombinedReportView extends ClientReportView {
+    queryClientId?: string;
+    condPanelClientId?: string;
+    paramPanelId?: string;
+}
+export interface ReportData {
+    matrix: any[][];
+}
+export interface CustomFilterDataBean {
+    fieldId: string;
+    operator1: string;
+    value1: string;
+    groupType: string;
+    operator2?: string;
+    value2?: string;
+    [key: string]: any;
+}
+export type AggregateType = 'SUM' | 'MIN' | 'MAX' | 'COUNT' | 'DISTINCT_COUNT' | 'AVG' | 'NULL';
+export type OrderType = 'ASC' | 'DESC' | 'NONE';
+export type OperatorType = '=' | '>' | '<';
+export interface DataSource {
+    id: string;
+    name: string;
+    alias?: string;
+    desc?: string;
+    user: string;
+    password?: string;
+    driverType: DriverType | string;
+    driver: string;
+    url: string;
+    maxConnection: number;
+    dbCharset?: string;
+    validationQuery?: string;
+    transactionIsolation: number;
+    validationQueryMethod: number;
+    authenticationType?: string;
+    driverCatalog?: string;
+}
+export type JDBCTableType = 'TABLE' | 'VIEW' | 'PROC' | 'MACRO';
+export interface JDBCTable {
+    catalog?: string;
+    schema?: string;
+    name: string;
+    desc?: string;
+    type: JDBCTableType;
+}
+export interface BasicField {
+    id: string;
+    name: string;
+    alias?: string;
+    desc?: string;
+    dataType: string;
+    dataFormat?: string;
+}
+export interface SDKCellData {
+    type?: string;
+    isNull?: boolean;
+    displayValue?: string;
+    stringValue?: string;
+    intValue?: number;
+    doubleValue?: number;
+    dateValue?: Date;
+    longValue?: number;
+    byteArrayValue?: Uint8Array | string | string[];
+    extendValue?: string;
+    useTransformRule?: boolean;
+    bigIntValue?: bigint;
+    bigDecimalValue?: number;
+}
+export interface SDKGridData {
+    totalRowsCount: number;
+    stringHeaders?: string[];
+    columnNames?: string[];
+    columnLabels?: string[];
+    data?: SDKCellData[][];
+}
+export type DriverType = 'KINGBASE' | 'ODBC' | 'MSSQL' | 'MYSQL' | 'ORACLE' | 'DB2_400' | 'DB2' | 'DB2_V9' | 'INFORMIX' | 'SYBASE' | 'TERADATA' | 'TERADATA_V12' | 'ACCESS' | 'EXCEL' | 'POSTGRESQL' | 'GREENPLUM' | 'DEFAULT';
+export interface SystemConfig {
+    key: string;
+    value: string;
+    longValue?: string;
+    [key: string]: any;
+}
+export interface IDocument {
+    id: string;
+    name: string;
+    alias?: string;
+    cnAlias?: string;
+    enAlias?: string;
+    twAlias?: string;
+    desc?: string;
+    cnDesc?: string;
+    enDesc?: string;
+    twDesc?: string;
+    type: string;
+    path?: string;
+    content?: string;
+    refid?: string[];
+    affid?: string[];
+    flag?: string;
+    docOrder?: number;
+    lastModified?: string;
+    indexLastModified?: string;
+    extended?: string;
+    [key: string]: any;
+}
+export interface DocumentTreeNode extends IDocument {
+    children?: DocumentTreeNode[];
+    parent?: DocumentTreeNode;
+    [key: string]: any;
+}
+export interface CategoryResource {
+    id: string;
+    name: string;
+    alias: string;
+    desc: string;
+    type: string;
+}
+export interface CalcField {
+    id: string;
+    name: string;
+    alias?: string;
+    desc?: string;
+    expression: string;
+    dataType: string;
+    dataFormat?: string;
+    condition?: string;
+    isInGroup?: string;
+    isBuildSql?: boolean;
+    [key: string]: any;
+}
+export interface TableField {
+    id: string;
+    name: string;
+    dateType: string;
+    columnSize: number;
+    decimalDigits: number;
+    [key: string]: any;
+}
+export interface GraphicReport {
+    clientId: string;
+    width: string;
+    height: string;
+    flashBasePath: string;
+    parameterPanelId: string;
+    params: Parameter[];
+    serviceName: string;
+    timeConsuming: any;
+    [key: string]: any;
+}
+export interface User {
+    id: string;
+    name: string;
+    alias?: string;
+    password?: string;
+    desc?: string;
+    enabled: string;
+    cellPhoneNumber?: string;
+    emailAddress?: string;
+    validityType?: string;
+    validityStartTime?: Date;
+    validityEndTime?: Date;
+    pwdLastModifyTime?: Date;
+    lastLoginTime?: Date;
+    assignedGroups?: any[];
+    assignedRoles?: any[];
+    createTime?: Date;
+    updateTime?: Date;
+    cellPhoneDecoded?: boolean;
+    emailDecoded?: boolean;
+    [key: string]: any;
+}
+export interface Role {
+    id: string;
+    name: string;
+    alias?: string;
+    desc?: string;
+    systemId?: string;
+    groupId?: string;
+    componentDefine?: string;
+    creatorGroup?: any;
+    groupToRole?: any[];
+    functions?: any[];
+    assignedUsers?: any[];
+    enabled?: string;
+    [key: string]: any;
+}
+export interface Department {
+    id: string;
+    name: string;
+    alias?: string;
+    desc?: string;
+    orgId?: string;
+    departmentCode?: string;
+    systemId?: string;
+    createTime?: Date;
+    updateTime?: Date;
+    enabled?: string;
+    parentGroup?: Department;
+    subGroups?: Department[];
+    assignedUsers?: User[];
+    groupToRole?: any[];
+    createdRoles?: Role[];
+    [key: string]: any;
+}
+export interface FunctionPermission {
+    id: string;
+    name: string;
+    alias?: string;
+    desc?: string;
+    systemId?: string;
+    isBuiltIn?: string;
+    order?: number;
+    parentFunction?: FunctionPermission;
+    subFunctions?: FunctionPermission[];
+    rolesToFunction?: Role[];
+    [key: string]: any;
+}
+export interface ExtensionAttribute {
+    id: string;
+    key: string;
+    value: string;
+    longValue?: string;
+    [key: string]: any;
+}
+export interface AllExportTypeMap {
+    EXCEL: 'EXCEL';
+    TXT: 'TXT';
+    CSV: 'CSV';
+    WORD: 'WORD';
+    WORD2003: 'WORD2003';
+    POWERPOINT: 'POWERPOINT';
+    PDF: 'PDF';
+    PNG: 'PNG';
+    EXCEL2007: 'EXCEL2007';
+    LIST_EXCEL: 'LIST_EXCEL';
+    HTML: 'HTML';
+}
+export type ReportExportType = keyof Pick<AllExportTypeMap, 'EXCEL' | 'TXT' | 'CSV'>;
+export type OfficeReportExportType = keyof Pick<AllExportTypeMap, 'WORD' | 'WORD2003' | 'POWERPOINT' | 'PDF'>;
+export type SSReportExportType = keyof Pick<AllExportTypeMap, 'PDF' | 'PNG' | 'WORD' | 'EXCEL2007' | 'LIST_EXCEL' | 'EXCEL' | 'HTML' | 'CSV'>;
+export type JSONArray = any[];
+export interface ReportBean {
+    params?: any[];
+    fields?: any[];
+    clientConfig?: string;
+}
+export interface ClientReportView {
+    clientId?: string;
+    reportBean?: ReportBean;
+}
+export interface ICombinedReport {
+    currentReportName: string;
+    rowsPerPage: number;
+    parameters?: any[];
+    fields?: any[];
+    [key: string]: any;
+}