@authing/react-ui-components 4.0.16-rc.2 → 4.0.16-tn.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@authing/react-ui-components",
-  "version": "4.0.16-rc.2",
+  "version": "4.0.16-tn.0",
   "private": false,
   "main": "lib/index.min.js",
   "typings": "types/index.d.ts",

package/types/Guard/module.d.ts

@@ -19,7 +19,9 @@ export declare const enum GuardModuleType {
     IDENTITY_BINDING_ASK = "identityBindingAsk",
     IDENTITY_BINDING = "identityBinding",
     SELF_UNLOCK = "selfUnlock",
-    FLOW_SELECT_ACCOUNT = "flowSelectAccount"
+    FLOW_SELECT_ACCOUNT = "flowSelectAccount",
+    /** 多租户门户选择页 */
+    TENANT_PORTAL = "tenant-portal"
 }
 export interface GuardModuleAction {
     action: string;

package/types/GuardFace/index.d.ts

@@ -0,0 +1,16 @@
+import './styles.less';
+import { AvatarProps } from 'antd/lib/avatar';
+import { TagProps } from 'antd/lib/tag';
+import React from 'react';
+export interface GuardFaceProps {
+    /** 顶部 avatar 头像展示 */
+    avatar: AvatarProps | string;
+    /** 标题头部 */
+    title: React.ReactNode;
+    /** 标题描述 */
+    description?: React.ReactNode;
+    /** 标签功能 */
+    tags?: TagProps[];
+}
+/** 顶部通用区域封装，同时兼容样式的层叠和功能的自定义 */
+export declare const GuardFace: (props: GuardFaceProps) => JSX.Element;

package/types/GuardSelect/index.d.ts

@@ -0,0 +1,29 @@
+import './styles.less';
+import { AvatarProps } from 'antd/lib/avatar';
+import { ListItemProps, ListProps } from 'antd/lib/list';
+import React, { CSSProperties } from 'react';
+export interface GuardSelectItem {
+    /** avatar 头像展示 */
+    avatar?: AvatarProps | string;
+    /** 标题 */
+    title?: React.ReactNode;
+    /** 描述 */
+    description?: React.ReactNode;
+    /** 右侧操作组 */
+    actions?: ListItemProps['actions'];
+    /** 右侧额外的渲染内容 */
+    extra?: ListItemProps['extra'];
+    /** 数据项子内容，便于自定义 */
+    children?: React.ReactNode;
+    /** 其他元字段 */
+    [key: string]: any;
+}
+export interface GuardSelectProps<T = any> extends ListProps<any> {
+    /**数据项之间的间隙，默认`20px` */
+    gap?: CSSProperties['marginBottom'];
+    /** 数据源 */
+    dataSource: T[];
+    onSelect?: (item?: T, index?: number) => void;
+}
+/** 选择列表组件 兼容绝大多数选择场景 */
+export declare const GuardSelect: <D extends GuardSelectItem = any>(props: GuardSelectProps<D>) => JSX.Element;

package/types/TenantPortalSelect/index.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="react" />
+import './styles.less';
+/** 租户门户选择状态机返回数据类型 */
+export interface TenantPortalSelectType {
+    title: string;
+    description: string;
+    logo: string;
+    list: {
+        tenantName: string;
+        tenantId: string;
+        tenantLogo: string;
+        host: string;
+        userName: string;
+    }[];
+}
+export declare const GuardTenantPortalSelectView: () => JSX.Element;

package/types/Type/application.d.ts

@@ -264,4 +264,10 @@ export interface ApplicationConfig {
      * 是否开启注册密码补全
      */
     enableCompletePassword: boolean;
+    /** 是否为租户控制台应用 */
+    isTenantConsole?: boolean;
+    /** 是否默认为租户应用面板应用 */
+    isTenantDefault?: boolean;
+    /** 租户详情 */
+    tenantInfo?: Record<string, any>;
 }

package/types/_utils/context.d.ts

@@ -4,6 +4,7 @@ import { BackFillMultipleState, StoreInstance } from '../Guard/core/hooks/useMul
 import { ModuleState } from '../Guard/GuardModule/stateMachine';
 import { ApplicationConfig } from '../Type/application';
 import { GuardHttp } from './guardHttp';
+import { MultipleTenant } from './tenant';
 export interface IGuardContext {
     finallyConfig: GuardLocalConfig;
     defaultMergedConfig: GuardLocalConfig;
@@ -42,6 +43,8 @@ export interface IGuardContext {
          */
         clearBackFillData?: () => void;
     };
+    /** 租户信息获取和操作处理相关 */
+    tenantInstance?: MultipleTenant;
 }
 export declare const createGuardXContext: () => {
     Provider: React.FC<{
@@ -137,3 +140,5 @@ export declare const useGuardMultipleInstance: () => {
      */
     clearBackFillData?: (() => void) | undefined;
 };
+/** 用来操作和获取租户相关的内容 */
+export declare const useGuardTenantProvider: () => MultipleTenant | undefined;

package/types/_utils/index.d.ts

@@ -27,7 +27,7 @@ export declare const getClassnames: (classnames: (string | boolean | undefined)[
  * @param item
  * @returns {boolean}
  */
-export declare function isObject(item: any): boolean;
+export declare function isObject(item: any): any;
 /**
  * https://www.itranslater.com/qa/details/2115518846294557696
  * Deep merge two objects.

package/types/_utils/responseManagement/interface.d.ts

@@ -17,6 +17,7 @@ export declare const enum ApiCode {
     FORCED_PASSWORD_RESET = 2058,
     UNSAFE_PASSWORD_TIP = 2061,
     UNSAFE_PASSWORD_RESET = 2071,
-    FLOW_SELECT_ACCOUNT = 2921
+    FLOW_SELECT_ACCOUNT = 2921,
+    TENANT_PORTAL = 1644
 }
 export declare const ChangeModuleApiCodeMapping: Record<string, GuardModuleType>;

package/types/_utils/tenant.d.ts

@@ -0,0 +1,19 @@
+import { ApplicationConfig } from '../Type';
+/** **当前租户应用** 下的租户信息获取和操作处理，将租户相关的处理收拢 */
+export declare class MultipleTenant {
+    private $config;
+    private $tenantId;
+    constructor(tenantId: string, config: ApplicationConfig);
+    /** 获取租户ID */
+    getCurrentTenantId: () => string | null;
+    /** 获取租户详情 */
+    getCurrentTenantInfo: () => Record<string, any> | undefined;
+    /**是否为【租户控制台】 */
+    isTenantConsole: () => boolean | undefined;
+    /** 是否为租户【单点登录】 */
+    isTenantSSO: () => boolean | undefined;
+    /** 是否为租户【单点登录面板】 */
+    isTenantSSOLaunchPad: () => boolean | undefined;
+}
+/** 初始化多租户实例 */
+export declare const useMultipleTenant: (tenantId: string, publicConfig: ApplicationConfig) => MultipleTenant | undefined;

package/types/version/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.0.16-rc.2";
+declare const _default: "4.0.16-tn.0";
 export default _default;