@das-fed/upf-utils 6.4.0-dev.259 → 6.4.0-dev.260

package/common-tools/timezone-format/get-iana-data/dayjs-timezone-iana-plugin.d.ts

@@ -0,0 +1,72 @@
+export interface TimeZoneRule {
+    u: number[];
+    o: number[];
+}
+export interface IanaDb {
+    [zone: string]: TimeZoneRule;
+}
+/** `dayjs.extend` 时无需传 IANA 数据；须先 `await plugin.preloadFromApi()`（默认请求内置路径并带 accessToken） */
+export type DayjsTimezoneIanaOption = undefined;
+export interface PackedIanaData {
+    version?: string;
+    zones: string[];
+    links?: string[];
+}
+export type ParsePackedIanaResponse = (json: unknown) => PackedIanaData;
+/** 默认 `fetch` 请求的第二个参数；自定义 `fetchJson` 时也会传入 */
+export type IanaFetchJson = (url: string, init?: RequestInit) => Promise<unknown>;
+export interface PreloadDayjsIanaOptions {
+    /** 默认 `/api/admin/basic-application/sys-info/v1/license/time-zone-packed-data`；未传则请求内置地址 */
+    url?: string;
+    /**
+     * 设置 `Authorization`；未传时从 `localStorage.getItem('accessToken')` 生成 `Bearer <token>`。
+     * 传 `''` 表示不附加鉴权头。
+     */
+    authorization?: string;
+    /** 额外请求头；与 `authorization` 合并，同名时以 `authorization` 为准 */
+    headers?: Record<string, string>;
+    /** 默认使用全局 `fetch`；Node 等环境可传入实现 */
+    fetchJson?: IanaFetchJson;
+    /** 接口外层包裹时在此解析为 `{ version?, zones, links? }` */
+    parseResponse?: ParsePackedIanaResponse;
+}
+type DayjsLike = {
+    utc: () => DayjsLike;
+    valueOf: () => number;
+    utcOffset: (offset: number, keepLocalTime?: boolean) => DayjsLike;
+    tz: (zone?: string, keepLocalTime?: boolean) => DayjsLike;
+};
+type DayjsClassLike = {
+    prototype: {
+        tz?: (zone?: string) => DayjsLike;
+    };
+};
+type DayjsFactoryLike = {
+    (value?: unknown, format?: string): DayjsLike;
+    utc?: (value?: unknown, format?: string) => DayjsLike;
+    tz?: DayjsTimezoneFactoryLike;
+};
+type DayjsTimezoneFactoryLike = {
+    (value?: unknown, timezoneOrFormat?: string, timezone?: string): DayjsLike;
+    setDefault?: (zone: string) => void;
+    guess?: () => string;
+};
+type DayjsPlugin = (option: DayjsTimezoneIanaOption | undefined, dayjsClass: DayjsClassLike, dayjsFactory: DayjsFactoryLike) => void;
+export type DayjsTimezoneIanaPlugin = DayjsPlugin & {
+    /** 请求接口并解析 packed 数据，写入内部缓存；须在 `dayjs.extend(plugin)` 之前 await 完成 */
+    preloadFromApi: (options?: PreloadDayjsIanaOptions) => Promise<PackedIanaData>;
+    /** 直接写入已获取的 packed 数据，避免业务层为了复用接口结果再发起请求 */
+    preloadFromData: (packedData: PackedIanaData) => PackedIanaData;
+    /** 返回最近一次写入的 packed 数据，供公共工具同步已知时区集合 */
+    getCachedPackedData: () => PackedIanaData | null;
+    /** 清空内部缓存（测试或切换数据源时使用） */
+    clearIanaCache: () => void;
+};
+export declare function assertPackedIanaData(json: unknown): PackedIanaData;
+export declare function preloadDayjsIanaFromData(packedData: PackedIanaData): PackedIanaData;
+export declare function getCachedDayjsPackedIanaData(): PackedIanaData | null;
+export declare function preloadDayjsIanaFromApi(options?: PreloadDayjsIanaOptions): Promise<PackedIanaData>;
+export declare function clearDayjsIanaCache(): void;
+export declare function createIanaDbFromPackedData(packedData: PackedIanaData): IanaDb;
+declare const plugin: DayjsTimezoneIanaPlugin;
+export default plugin;

package/common-tools/timezone-format/get-iana-data/iana-api-fetch.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 内置 IANA packed 数据接口路径（与网关 / 前端 base 拼接）。
+ */
+export declare const TIME_ZONE_PACKED_DATA_URL: string;
+/**
+ * 从浏览器 localStorage 读取 accessToken（非浏览器或无此项时返回 null）。
+ */
+export declare function getAccessTokenFromLocalStorage(): string | null;
+/**
+ * 默认 Authorization：`Bearer <accessToken>`；若 token 已含 `Bearer ` 则原样使用。
+ */
+export declare function getDefaultIanaAuthorization(): string | undefined;
+/**
+ * 构造 IANA 接口请求的 fetch init（Authorization 与其它头）。
+ * - 未传 `authorization` 时，自动使用 `localStorage.getItem('accessToken')` 生成 `Authorization`。
+ * - 传入 `authorization: ''` 表示不附加 Authorization（用于测试等场景）。
+ */
+export declare function buildIanaFetchInit(options?: {
+    authorization?: string;
+    headers?: Record<string, string>;
+}): RequestInit | undefined;

package/common-tools/timezone-format/get-iana-data/moment-iana-loader.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 将接口返回的 packed IANA 数据（与 moment-timezone 数据格式一致）注册到当前 moment 实例上。
+ * 业务侧须先：`import moment from 'moment'; import 'moment-timezone';`，再传入同一个 `moment`。
+ */
+export interface PackedIanaTzData {
+    version?: string;
+    zones: string[];
+    links?: string[];
+}
+export interface MomentWithTimezone {
+    tz: {
+        load: (data: PackedIanaTzData) => void;
+    };
+}
+export declare function assertPackedIanaTzData(json: unknown): PackedIanaTzData;
+export declare function loadIanaData(moment: MomentWithTimezone, data: PackedIanaTzData): void;
+export type ParseIanaResponse = (json: unknown) => PackedIanaTzData;
+export type IanaMomentFetchJson = (url: string, init?: RequestInit) => Promise<unknown>;
+export interface LoadIanaFromApiOptions {
+    /** 设置请求头 `Authorization`（完整值，如 `Bearer <token>`） */
+    authorization?: string;
+    /** 额外请求头；与 `authorization` 合并，同名时以 `authorization` 为准 */
+    headers?: Record<string, string>;
+    /** 自定义请求，默认使用全局 fetch */
+    fetchJson?: IanaMomentFetchJson;
+    /** 当接口外层有包裹时，在此取出 { version, zones, links } */
+    parseResponse?: ParseIanaResponse;
+}
+export declare function loadIanaFromApi(moment: MomentWithTimezone, urlOrOptions?: string | LoadIanaFromApiOptions, maybeOptions?: LoadIanaFromApiOptions): Promise<PackedIanaTzData>;

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

@@ -1,80 +1,9 @@
 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';
 
-export interface TimeZoneRule {
-    u: number[];
-    o: number[];
-}
-export interface IanaDb {
-    [zone: string]: TimeZoneRule;
-}
-export type DayjsTimezoneIanaOption = undefined;
-export interface PackedIanaData {
-    version?: string;
-    zones: string[];
-    links?: string[];
-}
-export type ParsePackedIanaResponse = (json: unknown) => PackedIanaData;
-export type IanaFetchJson = (url: string, init?: RequestInit) => Promise<unknown>;
-export interface PreloadDayjsIanaOptions {
-    /** 默认请求内置 IANA packed 数据接口；可传自定义地址覆盖。 */
-    url?: string;
-    /** 设置 Authorization；传空字符串表示不附加鉴权头。 */
-    authorization?: string;
-    /** 额外请求头；与 authorization 合并，同名时以 authorization 为准。 */
-    headers?: Record<string, string>;
-    /** 默认使用全局 fetch；Node 等环境可传入实现。 */
-    fetchJson?: IanaFetchJson;
-    /** 接口外层包裹时在此解析为 packed IANA 数据。 */
-    parseResponse?: ParsePackedIanaResponse;
-}
-export type DayjsTimezoneIanaPlugin = ((option?: DayjsTimezoneIanaOption, dayjsClass?: unknown, dayjsFactory?: unknown) => void) & {
-    preloadFromApi: (options?: PreloadDayjsIanaOptions) => Promise<PackedIanaData>;
-    preloadFromData: (packedData: PackedIanaData) => PackedIanaData;
-    getCachedPackedData: () => PackedIanaData | null;
-    clearIanaCache: () => void;
-};
-export interface PackedIanaTzData {
-    version?: string;
-    zones: string[];
-    links?: string[];
-}
-export type MomentTimezoneApi = {
-    load: (data: PackedIanaTzData) => void;
-};
-export interface MomentWithTimezone {
-    tz: MomentTimezoneApi | (((...args: any[]) => unknown) & MomentTimezoneApi);
-}
-export type ParseIanaResponse = (json: unknown) => PackedIanaTzData;
-export type IanaMomentFetchJson = (url: string, init?: RequestInit) => Promise<unknown>;
-export interface LoadIanaFromApiOptions {
-    /** 设置请求头 Authorization。 */
-    authorization?: string;
-    /** 额外请求头；与 authorization 合并，同名时以 authorization 为准。 */
-    headers?: Record<string, string>;
-    /** 自定义请求，默认使用全局 fetch。 */
-    fetchJson?: IanaMomentFetchJson;
-    /** 当接口外层有包裹时，在此取出 packed IANA 数据。 */
-    parseResponse?: ParseIanaResponse;
-}
-export declare const dayjsTimezoneIanaPlugin: DayjsTimezoneIanaPlugin;
-export declare const assertPackedIanaData: (json: unknown) => PackedIanaData;
-export declare const preloadDayjsIanaFromData: (packedData: PackedIanaData) => PackedIanaData;
-export declare const getCachedDayjsPackedIanaData: () => PackedIanaData | null;
-export declare const preloadDayjsIanaFromApi: (options?: PreloadDayjsIanaOptions) => Promise<PackedIanaData>;
-export declare const clearDayjsIanaCache: () => void;
-export declare const createIanaDbFromPackedData: (packedData: PackedIanaData) => IanaDb;
-export declare const TIME_ZONE_PACKED_DATA_URL: string;
-export declare const getAccessTokenFromLocalStorage: () => string | null;
-export declare const getDefaultIanaAuthorization: () => string | undefined;
-export declare const buildIanaFetchInit: (options?: {
-    authorization?: string;
-    headers?: Record<string, string>;
-}) => RequestInit | undefined;
-export declare const assertPackedIanaTzData: (json: unknown) => PackedIanaTzData;
-export declare const loadMomentIanaData: (moment: MomentWithTimezone, data: PackedIanaTzData) => void;
-export declare const loadIanaData: (moment: MomentWithTimezone, data: PackedIanaTzData) => void;
-export declare const loadMomentIanaFromApi: (moment: MomentWithTimezone, urlOrOptions?: string | LoadIanaFromApiOptions, maybeOptions?: LoadIanaFromApiOptions) => Promise<PackedIanaTzData>;
-export declare const loadIanaFromApi: (moment: MomentWithTimezone, urlOrOptions?: string | LoadIanaFromApiOptions, maybeOptions?: LoadIanaFromApiOptions) => Promise<PackedIanaTzData>;
+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';
@@ -165,21 +94,9 @@ export interface FormatLocalDateTimeOptions {
     /** 未传 timeZone 时是否读取 sessionStorage/客户端时区。默认 false，兼容旧 toLocalDate。 */
     useClientTimeZone?: boolean;
 }
-export interface FormatLocalDateTimeIntlOptions {
-    /** 目标 IANA 时区；为空时读取浏览器当前时区。 */
-    timeZone?: string | null;
-    /** 输出格式，默认 YYYY-MM-DD HH:mm:ss。 */
-    format?: string;
-    /** Intl locale，默认 zh-CN，保证中后台测试文案稳定。 */
-    locale?: string;
-}
 export interface ApplyIanaTimeZoneOptions {
     /** 指定默认时区，后续 dayjs.tz(value) 可直接使用。 */
     defaultTimeZone?: string;
-    /** 运行期快照来源：接口数据为 iana，随包数据或本地兜底为 fallback。 */
-    runtimeSource?: IanaTimeZoneDataSource;
-    /** 是否把 packed 数据写到 window 快照，供 iframe 子应用复用。默认 true。 */
-    writeRuntimeSnapshot?: boolean;
 }
 export interface LoadIanaTimeZoneOptions extends PreloadDayjsIanaOptions, ApplyIanaTimeZoneOptions {
 }
@@ -187,11 +104,6 @@ export interface ApplyIanaTimeZoneResult {
     data: PackedIanaData;
     knownTimeZones: string[];
 }
-export type IanaTimeZoneDataSource = 'iana' | 'fallback';
-export interface RuntimeIanaTimeZoneDataSnapshot extends PackedIanaData {
-    source: IanaTimeZoneDataSource;
-    timestamp: number;
-}
 export interface LoadMomentIanaTimeZoneOptions extends LoadIanaFromApiOptions {
     url?: string;
 }
@@ -214,21 +126,9 @@ export interface SetClientTimeZoneOptions {
     source?: string;
 }
 export type ClientTimeZoneChangeHandler = (timeZone: string, detail: ClientTimeZoneChangeDetail) => void;
-export interface ClientTimeZoneRef {
-    /** 框架无关的当前时区快照；Vue/Angular/原生应用都可直接读取。 */
-    value: string;
-}
 export declare const TIMEZONE_CHANGE_EVENT = "timezonechange";
 export declare const UPF_TIMEZONE_MESSAGE_TYPE = "__UPF_TIMEZONE_CHANGE__";
-export declare const UPF_IANA_TIMEZONE_DATA_KEY = "__UPF_IANA_TIMEZONE_DATA__";
-export declare const IANA_TIMEZONE_DATA_CHANGE_EVENT = "ianatimezonedatachange";
-export declare const setRuntimeIanaTimeZoneDataSnapshot: (data: PackedIanaData, options?: {
-    source?: IanaTimeZoneDataSource;
-    dispatchEvent?: boolean;
-}) => RuntimeIanaTimeZoneDataSnapshot | null;
-export declare const getRuntimeIanaTimeZoneDataSnapshot: () => RuntimeIanaTimeZoneDataSnapshot | null;
-export declare const readInjectedParentIanaTimeZoneDataSnapshot: () => RuntimeIanaTimeZoneDataSnapshot | null;
-export declare const clientTimeZone: ClientTimeZoneRef;
+export declare const clientTimeZone: any;
 export declare const isKnownTimeZone: (timeZone?: string | null) => any;
 export declare const rebuildKnownTimeZoneIds: (data: Pick<PackedIanaData, "zones" | "links">) => any;
 export declare const getKnownTimeZoneIds: () => any;
@@ -237,7 +137,6 @@ export declare const loadDayjsIanaTimeZoneData: (options?: LoadIanaTimeZoneOptio
 export declare const applyMomentIanaTimeZoneData: (moment: MomentWithTimezone, data: PackedIanaTzData) => PackedIanaTzData;
 export declare const loadMomentIanaTimeZoneData: (moment: MomentWithTimezone, options?: LoadMomentIanaTimeZoneOptions) => unknown;
 export declare const setDefaultTimeZone: (timeZone?: string | null) => boolean;
-export declare const ensureInjectedIanaTimeZoneData: () => Promise<ApplyIanaTimeZoneResult | null>;
 export declare const setClientTimeZone: (timeZone?: string | null, options?: SetClientTimeZoneOptions) => any;
 export declare const syncClientTimeZone: (source?: string) => any;
 export declare const onClientTimeZoneChange: (handler: ClientTimeZoneChangeHandler) => () => any;
@@ -249,9 +148,6 @@ export declare const getZoneUtcOffset: (value: TimeValue, timeZone?: string | nu
 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 getBrowserTimeZone: () => any;
-export declare function formatLocalDateTimeIntl(value?: TimeValue, timeZone?: string | null, format?: string, locale?: string): string;
-export declare function formatLocalDateTimeIntl(value?: TimeValue, options?: FormatLocalDateTimeIntlOptions): 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;
@@ -260,4 +156,3 @@ export declare const isDaylightSavingTime: (timeZone?: string | null, value?: Ti
 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 {};