@das-fed/upf-utils 6.4.0-dev.243 → 6.4.0-dev.244

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

@@ -1,6 +1,54 @@
 import { 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';
 
-type TimeValue = string | number | Date | Dayjs | null | undefined;
+export * from './get-iana-data';
+export { dayjsTimezoneIanaPlugin, loadMomentIanaData, loadMomentIanaFromApi };
+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';
+interface MomentFormatValue {
+    tz?: (timeZone: string) => MomentFormatValue;
+    format: (format?: string) => string;
+    isValid?: () => boolean;
+}
+export interface MomentTimezoneFormatInstance extends MomentWithTimezone {
+    (value?: unknown): MomentFormatValue;
+    tz: MomentWithTimezone['tz'] & {
+        (value?: unknown, timeZone?: string): MomentFormatValue;
+        guess?: () => string;
+        setDefault?: (zone: string) => void;
+    };
+}
+export interface TimeZoneOption {
+    /** IANA 时区标识，如 Asia/Shanghai。 */
+    timeZoneId: string;
+    /** 后端下发的本地化展示名。 */
+    tzShowName?: string;
+    /** 关联城市名，保留给后续业务自定义展示。 */
+    cities?: string[];
+    /** 1 表示存在夏令时规则，0 表示固定偏移。 */
+    dynamicOffsetFlag?: TimeZoneFlag;
+    /** 1 表示当前处于夏令时，0 表示当前非夏令时。 */
+    currentDstFlag?: TimeZoneFlag;
+    /** 标准 UTC 偏移量文本，如 +08:00。 */
+    baseUtcOffsetText?: string;
+    /** 当前实际 UTC 偏移量文本，包含夏令时偏移。 */
+    currentUtcOffsetText?: string;
+}
+export interface TimeZoneDisplayOption {
+    /** IANA 时区标识，作为下拉 value。 */
+    value: string;
+    /** 下拉展示文本。 */
+    label: string;
+    /** 主展示区使用的时区名称。 */
+    zoneName: string;
+    /** 是否存在夏令时规则。 */
+    hasDST: boolean;
+    /** 当前是否处于夏令时。 */
+    isDST: boolean;
+}
 export interface TimeZoneDisplayOptions {
     value?: TimeValue;
     locale?: string;
@@ -21,8 +69,64 @@ export interface TimeZoneDisplayResult {
     isDaylightSavingTime: boolean;
     daylightSavingLabel: string;
 }
+export interface FormatClientLocalDateTimeLineOptions {
+    showZoneLabel?: boolean;
+    zoneLabel?: string;
+    /** 是否存在夏令时规则；未传时回退本地规则判断。 */
+    hasDST?: boolean;
+    /** 当前是否处于夏令时；未传时回退本地规则判断。 */
+    isDST?: boolean;
+    standardTimeLabel?: string;
+    daylightSavingLabel?: string;
+    format?: string;
+}
+export interface FormatLocalDateTimeOptions {
+    /** 输出格式，默认 YYYY-MM-DD HH:mm:ss。 */
+    format?: string;
+    /** 目标 IANA 时区；为空时保持时间库本机格式化行为。 */
+    timeZone?: string | null;
+    /** 使用的时间库，默认 dayjs；c3 可传 moment。 */
+    dateLibrary?: TimeZoneDateLibrary;
+    /** moment 模式必须传当前应用同一个 moment-timezone 实例。 */
+    moment?: MomentTimezoneFormatInstance;
+    /** instant 表示转换真实时间点，local 表示把输入文本按目标时区本地时间解析。 */
+    inputMode?: TimeZoneInputMode;
+    /** 未传 timeZone 时是否读取 sessionStorage/客户端时区。默认 false，兼容旧 toLocalDate。 */
+    useClientTimeZone?: boolean;
+}
+export interface ApplyIanaTimeZoneOptions {
+    /** 指定默认时区，后续 dayjs.tz(value) 可直接使用。 */
+    defaultTimeZone?: string;
+}
+export interface LoadIanaTimeZoneOptions extends PreloadDayjsIanaOptions, ApplyIanaTimeZoneOptions {
+}
+export interface ApplyIanaTimeZoneResult {
+    data: PackedIanaData;
+    knownTimeZones: string[];
+}
+export interface LoadMomentIanaTimeZoneOptions extends LoadIanaFromApiOptions {
+    url?: string;
+}
+export declare const isKnownTimeZone: (timeZone?: string | null) => any;
+export declare const rebuildKnownTimeZoneIds: (data: Pick<PackedIanaData, "zones" | "links">) => any;
+export declare const getKnownTimeZoneIds: () => any;
+export declare const applyDayjsIanaTimeZoneData: (data: PackedIanaData, options?: ApplyIanaTimeZoneOptions) => Promise<ApplyIanaTimeZoneResult>;
+export declare const loadDayjsIanaTimeZoneData: (options?: LoadIanaTimeZoneOptions) => Promise<ApplyIanaTimeZoneResult>;
+export declare const applyMomentIanaTimeZoneData: (moment: MomentWithTimezone, data: PackedIanaTzData) => PackedIanaTzData;
+export declare const loadMomentIanaTimeZoneData: (moment: MomentWithTimezone, options?: LoadMomentIanaTimeZoneOptions) => unknown;
 export declare const getClientTimeZone: () => any;
+export declare const resolveTimeZone: (timeZone?: string | null) => any;
+export declare const setDefaultTimeZone: (timeZone?: string | null) => boolean;
 export declare const normalizeLocaleCode: (locale?: string, supportedLocales?: string[]) => any;
-export declare const isDaylightSavingTime: (timeZone?: string, value?: TimeValue) => boolean;
+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 formatLocalDateTime: (value?: TimeValue, options?: FormatLocalDateTimeOptions | 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;
+export declare const timeZoneHasDST: (timeZone?: string | null, value?: TimeValue) => boolean;
+export declare const timeZoneIsDST: (timeZone?: string | null, value?: TimeValue) => boolean;
+export declare const isDaylightSavingTime: (timeZone?: string | null, value?: TimeValue) => boolean;
+export declare const buildTimeZoneDisplayOptions: (options: TimeZoneOption[], referenceDate?: Date) => TimeZoneDisplayOption[];
+export declare const formatClientLocalDateTimeLine: (value: TimeValue, timeZone?: string | null, options?: FormatClientLocalDateTimeLineOptions) => any;
 export declare const getTimeZoneDisplayInfo: (options?: TimeZoneDisplayOptions) => TimeZoneDisplayResult;
-export {};