@das-fed/upf-utils 6.4.0-dev.270 → 6.4.0-dev.272

package/common-tools/timezone-format/es5.d.ts

@@ -9,6 +9,7 @@ export type TimeValue = string | number | Date | Dayjs | null | undefined;
 export type TimeZoneFlag = number | string | null | undefined;
 export type TimeZoneDateLibrary = 'dayjs' | 'moment';
 export type TimeZoneInputMode = 'instant' | 'local';
+export type TimeZonePickerMode = 'none' | 'instant' | 'local';
 interface MomentFormatValue {
     tz?: (timeZone: string) => MomentFormatValue;
     format: (format?: string) => string;
@@ -103,6 +104,24 @@ export interface FormatLocalDateTimeIntlOptions {
     /** Intl 本地化语言，默认 zh-CN。 */
     locale?: string;
 }
+export interface TimeZonePickerOptions {
+    /** none 保持原行为；instant 表示真实时间点；local 表示业务时区本地时间。 */
+    timeZoneMode?: TimeZonePickerMode;
+    /** 显式业务时区，优先级高于 useClientTimeZone。 */
+    timeZone?: string | null;
+    /** 是否读取当前客户端/右上角选择的时区。 */
+    useClientTimeZone?: boolean;
+    /** 开启时区模式后的输出格式；未传时 instant 默认带 offset，local 默认本地时间文本。 */
+    timeZoneValueFormat?: string;
+}
+export interface TimeZoneDayBoundaryOptions {
+    /** 显式业务时区；为空时可配合 useClientTimeZone 读取当前用户时区。 */
+    timeZone?: string | null;
+    /** 是否读取当前客户端/右上角选择的时区。 */
+    useClientTimeZone?: boolean;
+    /** date 保留输入日期标签；instant 按真实时间点在目标时区所属日期计算。 */
+    inputMode?: 'date' | 'instant';
+}
 export interface ApplyIanaTimeZoneOptions {
     /** 指定默认时区，后续 dayjs.tz(value) 可直接使用。 */
     defaultTimeZone?: string;
@@ -168,10 +187,16 @@ export declare const onClientTimeZoneChange: (handler: ClientTimeZoneChangeHandl
 export declare const initClientTimeZoneSync: () => boolean;
 export declare const getClientTimeZone: () => any;
 export declare const resolveTimeZone: (timeZone?: string | null) => any;
+export declare const resolvePickerTimeZone: (options?: TimeZonePickerOptions) => any;
+export declare const isTimeZonePickerModeEnabled: (options?: TimeZonePickerOptions) => boolean;
 export declare const normalizeLocaleCode: (locale?: string, supportedLocales?: string[]) => any;
 export declare const getTimeZoneDayjs: () => TimeZoneDayjsFactory;
+export declare const toTimeZonePickerValue: <T extends TimeValue>(value?: T, options?: TimeZonePickerOptions) => any;
+export declare const fromTimeZonePickerValue: (value?: TimeValue, options?: TimeZonePickerOptions) => any;
 export declare const getZoneUtcOffset: (value: TimeValue, timeZone?: string | null) => any;
 export declare const formatInTimeZone: (value?: TimeValue, timeZone?: string | null, format?: string) => any;
+export declare const toTimestampAtZoneStartOfDay: (value?: TimeValue, options?: TimeZoneDayBoundaryOptions) => number | undefined;
+export declare const toTimestampAtZoneEndOfDay: (value?: TimeValue, options?: TimeZoneDayBoundaryOptions) => number | undefined;
 export declare const isMomentTimezoneFormatInstance: (moment?: unknown) => moment is MomentTimezoneFormatInstance;
 export declare const formatLocalDateTime: (value?: TimeValue, options?: FormatLocalDateTimeOptions | string) => string;
 export declare const formatLocalDateTimeIntl: (value?: TimeValue, options?: FormatLocalDateTimeIntlOptions | string) => string;