@quickbi/bi-open 4.0.0

package/cjs/index.d.ts

@@ -0,0 +1,145 @@
+// Generated by dts-bundle v0.7.3
+// Dependencies for this module:
+//   ../../../../../../../../../../@quickbi/bi-types
+
+declare module '@quickbi/bi-open' {
+    export type * as Interfaces from '@quickbi/bi-open/interfaces';
+    export { formatNumberWithConfig, formatNumber } from '@quickbi/bi-open/utils/format';
+    export { I18n } from '@quickbi/bi-open/utils/i18n';
+    export { revisal, LATEST_VERSION, OLDEST_VERSION, getRevisalRange, isOldestVersion } from '@quickbi/bi-open/revisal';
+}
+
+declare module '@quickbi/bi-open/interfaces' {
+    export type { ComponentMeta, ComponentMetaPropsSchema } from '@quickbi/bi-types';
+    export type { Lifecycle, LifecycleProps, LifecycleBootstrap, LifecycleMount, LifecycleUpdate, LifecycleUnmount, } from '@quickbi/bi-types';
+    export type { ComponentProps } from '@quickbi/bi-types';
+    export type { DataSchema, DataSchemaArea, DataSchemaAreaRule, DataSchemaAreaId, } from '@quickbi/bi-types';
+    export type { StyleSchema, StyleSchemaBase, StyleSchemaArray, StyleSchemaObject, StyleSchemaDepend, StyleSchemaDependId, StyleSchemaProperties, StyleSchemaValidation, StyleSchemaValidationRule, StyleSchemaValidationResult, } from '@quickbi/bi-types';
+    /** 自定义菜单 */
+    export type { MenuSchema, MenuSchemaBase, MenuSchemaItem, MenuMeta, MenuPageConfig, MenuComponentProps, MenuComponentChartProps, MenuComponentExcelProps, MenuComponentDashboardProps, MenuChart, MenuSheet, } from '@quickbi/bi-types';
+    /** 自定义页面 */
+    export type { PageComponentProps } from '@quickbi/bi-types';
+}
+
+declare module '@quickbi/bi-open/utils/format' {
+    /**
+        * 格式化数字
+        * formatNumber(1234, '#,##0')=1,234
+        * formatNumber(1.234, '0.##')=1.234
+        * formatNumber(12, '0.##')=12
+        * formatNumber(12.34, '0')=12
+        * formatNumber(12.34, '0.#')=12.3
+        * formatNumber(0.1, '%')=10%
+        * formatNumber(0.001, '0.#%')=0.1%
+        * formatNumber(0.01, '‰')=10‰
+        * @param num {Number|Object} 数字或null
+        * @param [partten] {String} 格式化样式,支持#0%‰,.不指定时返回原始值
+        * @param [invalidString] {String} 若是无效字符，返回是‘-’，还是N/A
+        * @returns {Number|Object} 处理后的
+        */
+    export function formatNumber(num: number | string, partten: 'CN' | 'CNT' | 'CN2' | 'EN' | 'KMG' | string, invalidString?: string): string | number;
+    /**
+        * 根据配置, 格式化数字
+        * @param num
+        * @param config fieldSettingMap
+        */
+    export function formatNumberWithConfig(num: number | string, config: any): any;
+}
+
+declare module '@quickbi/bi-open/utils/i18n' {
+    /**
+        * @author 海狸
+        * @description 开放组件国际化
+        */
+    type ILng = 'zh-CN' | 'en-US';
+    interface IResource {
+            [key: string]: string;
+    }
+    type IResources = Partial<{
+            [key in ILng]: IResource;
+    }>;
+    type IOption = {
+            /**
+                * 当前语言
+                */
+            lng?: ILng;
+            /**
+                * 语言包
+                */
+            resources: IResources;
+    };
+    type IParam = {
+            [key: string]: string | number | boolean;
+    };
+    export class I18n {
+            lng: ILng;
+            resources: IResources;
+            constructor(options: IOption);
+            /**
+                * 初始化
+                * 国际化词条绑定在全局对象上, meta 和 component 就可以复用
+                * 从而减少打包体积
+                */
+            static init(options: IOption): I18n;
+            /**
+                * 翻译函数
+                * 例如: t("{{who}}吃{{count}}个苹果", { who: t("我们"), count: 2 })
+                * @param key
+                * @param param
+                */
+            t(key: string, param?: IParam): string;
+    }
+    export {};
+}
+
+declare module '@quickbi/bi-open/revisal' {
+    import type { ComponentMeta } from '@quickbi/bi-types';
+    /**
+        * 获取订正范围
+        * @param version
+        * @param changeLog
+        * @returns
+        */
+    export function getRevisalRange(version: string, changeLog?: import("./changelog").ChangeLog[]): import("./changelog").ChangeLog[];
+    /**
+        * 订正到当前最新版本
+        * @param componentMeta
+        * @param currentVersion
+        * @param changeLog
+        * @returns
+        */
+    export function revisal(componentMeta: any, currentVersion: string, changeLog?: import("./changelog").ChangeLog[]): ComponentMeta;
+    /**
+        * 判断是否是最开始订正的版本的 componentMeta
+        */
+    export function isOldestVersion(componentMeta: any): boolean;
+    export { LATEST_VERSION, CHANGE_LOGS, OLDEST_VERSION } from '@quickbi/bi-open/revisal/changelog';
+}
+
+declare module '@quickbi/bi-open/revisal/changelog' {
+    /**
+        * @author 海狸
+        * @description
+        * 自定义组件订正
+        *
+        * [非常重要]: 独立部署不要做订正!!!!!!
+        */
+    import type { ComponentMeta } from '@quickbi/bi-types';
+    export interface ChangeLog {
+            /** 订正的版本 */
+            version: string;
+            /** 要订正的组件 */
+            guards?: Guard[];
+    }
+    export type Guard = (componentMeta: any) => ComponentMeta;
+    /** 最老的订正版本号 */
+    export const OLDEST_VERSION = "4.0.3";
+    /**
+        * 订正日志
+        * 按版本先后排序
+        */
+    export const CHANGE_LOGS: ChangeLog[];
+    /** 返回当前最新的版本 */
+    export const LATEST_VERSION: string;
+}
+