@das-fed/upf-utils 6.4.0-dev.286 → 6.4.0-dev.288

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

@@ -1,13 +1,15 @@
-import { Dayjs } from 'dayjs';
+import { default as dayjs, Dayjs } from 'dayjs';
 import { default as dayjsTimezoneIanaPlugin, PackedIanaData, PreloadDayjsIanaOptions } from './get-iana-data/dayjs-timezone-iana-plugin';
 import { loadIanaData as loadMomentIanaData, loadIanaFromApi as loadMomentIanaFromApi, LoadIanaFromApiOptions, MomentWithTimezone, PackedIanaTzData } from './get-iana-data/moment-iana-loader';
 
 export * from './get-iana-data';
 export { dayjsTimezoneIanaPlugin, loadMomentIanaData, loadMomentIanaFromApi };
+export type TimeZoneDayjsFactory = typeof dayjs;
 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;
@@ -94,9 +96,39 @@ export interface FormatLocalDateTimeOptions {
     /** 未传 timeZone 时是否读取 sessionStorage/客户端时区。默认 false，兼容旧 toLocalDate。 */
     useClientTimeZone?: boolean;
 }
+export interface FormatLocalDateTimeIntlOptions {
+    /** 输出格式，支持常用 YYYY/MM/DD/HH/mm/ss/SSS token，默认 YYYY-MM-DD HH:mm:ss。 */
+    format?: string;
+    /** 目标 IANA 时区；为空时读取当前客户端时区。 */
+    timeZone?: string | null;
+    /** 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;
+    /** 写入运行期快照的数据来源，供 mframe 注入 iframe 首屏复用。 */
+    runtimeSource?: RuntimeIanaTimeZoneDataSource;
+    /** 是否同步 window.__UPF_IANA_TIMEZONE_DATA__ 并派发事件，默认 true。 */
+    syncRuntimeSnapshot?: boolean;
 }
 export interface LoadIanaTimeZoneOptions extends PreloadDayjsIanaOptions, ApplyIanaTimeZoneOptions {
 }
@@ -126,8 +158,21 @@ export interface SetClientTimeZoneOptions {
     source?: string;
 }
 export type ClientTimeZoneChangeHandler = (timeZone: string, detail: ClientTimeZoneChangeDetail) => void;
+export type RuntimeIanaTimeZoneDataSource = 'iana' | 'fallback';
+export interface RuntimeIanaTimeZoneDataSnapshot extends PackedIanaData {
+    /** 数据来源：接口 IANA 数据或降级兜底数据。 */
+    source: RuntimeIanaTimeZoneDataSource;
+    /** 写入快照时间，供宿主和 iframe 判断是否需要刷新。 */
+    timestamp: number;
+}
 export declare const TIMEZONE_CHANGE_EVENT = "timezonechange";
 export declare const UPF_TIMEZONE_MESSAGE_TYPE = "__UPF_TIMEZONE_CHANGE__";
+export declare const IANA_TIMEZONE_DATA_CHANGE_EVENT = "ianatimezonedatachange";
+export declare const timeZoneDayjs: TimeZoneDayjsFactory;
+export declare const setRuntimeIanaTimeZoneDataSnapshot: (data: Pick<PackedIanaData, "version" | "zones" | "links">, source?: RuntimeIanaTimeZoneDataSource) => RuntimeIanaTimeZoneDataSnapshot;
+export declare const getRuntimeIanaTimeZoneDataSnapshot: () => RuntimeIanaTimeZoneDataSnapshot | null;
+export declare const getRuntimeNameZoneDataSnapshot: () => RuntimeIanaTimeZoneDataSnapshot | null;
+export declare const readInjectedParentIanaTimeZoneDataSnapshot: () => RuntimeIanaTimeZoneDataSnapshot | null;
 export declare const clientTimeZone: any;
 export declare const isKnownTimeZone: (timeZone?: string | null) => any;
 export declare const rebuildKnownTimeZoneIds: (data: Pick<PackedIanaData, "zones" | "links">) => any;
@@ -143,10 +188,19 @@ 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;
 export declare const toLocalDate: (value?: TimeValue, format?: string, options?: Omit<FormatLocalDateTimeOptions, "format">) => string;
 export declare const formatTimeZoneOffsetLabel: (value?: TimeValue, timeZone?: string | null) => string;
 export declare const resolveUtcOffsetFallback: (option: Pick<TimeZoneOption, "timeZoneId" | "baseUtcOffsetText" | "currentUtcOffsetText">, referenceDate?: Date) => string;