@apollo-design/locale 0.0.0-stage → 0.1.9

package/dist/index.d.mts

@@ -0,0 +1,564 @@
+import * as vue from 'vue';
+import { VNodeChild, MaybeRefOrGetter, InjectionKey, PropType, SlotsType, ComputedRef } from 'vue';
+
+/**
+ * `@apollo-design/locale` 的类型契约。
+ *
+ * 逐字段对齐 antd 6.6.4 的 `es/locale/index.d.ts` 与各分片的 `.d.ts`：
+ * `pagination/Pagination.d.ts` / `date-picker/generatePicker/interface.d.ts` /
+ * `table/interface.d.ts` / `modal/interface.d.ts` / `tour/interface.d.ts` /
+ * `popconfirm/PurePanel.d.ts` / `transfer/index.d.ts` / `upload/interface.d.ts` /
+ * `empty/index.d.ts` / `time-picker/index.d.ts`。
+ *
+ * ⚠️ **两处类型不能照抄上游的 import 路径**：
+ *   - `PaginationLocale` 上游从 `@rc-component/pagination` 引，
+ *   - `PickerLocale.lang` 上游从 `@rc-component/picker/interface` 引。
+ *   本包 `dependsOn: []`，**不依赖任何 rc 包**，所以这两个接口按
+ *   「我们实际发布的数据形状」**结构化重写**。字段集是从固化数据里探出来的
+ *   （见契约文档 §2 与 §9 第 4 条）—— 不是凭记忆写的。
+ *
+ * ⚠️ 上游用 `React.ReactNode` 的地方这里用 Vue 的 `VNodeChild`，
+ *   保持「可以传节点」的表达力（消费方从 antd 迁过来时不会因为类型太窄而报错）。
+ */
+
+/**
+ * 分页的语言数据。11 个字段，**全部是 string**。
+ *
+ * ⚠️ 字段名是 `snake_case`（`items_per_page` / `prev_5`），与 antd 其它分片的
+ * `camelCase` 不一致 —— 这是 rc-pagination 的既有形状，照抄。
+ */
+interface PaginationLocale {
+    items_per_page: string;
+    jump_to: string;
+    /** ⚠️ 部分语言没有（实测 73 个包里 71 个有） */
+    jump_to_confirm?: string;
+    page: string;
+    prev_page: string;
+    next_page: string;
+    prev_5: string;
+    next_5: string;
+    prev_3: string;
+    next_3: string;
+    /** ⚠️ 部分语言没有（实测 73 个包里 71 个有） */
+    page_size?: string;
+}
+interface TimePickerLocale {
+    placeholder?: string;
+    rangePlaceholder?: [string, string];
+}
+/**
+ * 日期选择器的 `lang` 部分（上游是 `RcPickerLocale & AdditionalPickerLocaleLangProps`）。
+ *
+ * ⚠️ 前四个字段（`yearFormat` / `dayFormat` / `cellMeridiemFormat` / `monthBeforeYear`）
+ * 来自 rc-picker 的 `commonLocale`，**每个语言包都有**；
+ * `shortWeekDays` / `shortMonths` **只有 5 个语言有**（`it_IT` / `mr_IN` / `pt_BR` /
+ * `pt_PT` / `tr_TR`），所以是可选的。
+ */
+interface PickerLangLocale {
+    yearFormat: string;
+    monthBeforeYear: boolean;
+    locale: string;
+    today: string;
+    now: string;
+    backToToday: string;
+    ok: string;
+    clear: string;
+    week: string;
+    month: string;
+    year: string;
+    timeSelect: string;
+    dateSelect: string;
+    monthSelect: string;
+    yearSelect: string;
+    decadeSelect: string;
+    previousMonth: string;
+    nextMonth: string;
+    previousYear: string;
+    nextYear: string;
+    previousDecade: string;
+    nextDecade: string;
+    previousCentury: string;
+    nextCentury: string;
+    placeholder: string;
+    rangePlaceholder: [string, string];
+    /** 71/73 */
+    dayFormat?: string;
+    /** 70/73 */
+    cellMeridiemFormat?: string;
+    /** 62/73 */
+    yearPlaceholder?: string;
+    /** 63/73 */
+    quarterPlaceholder?: string;
+    /** 63/73 */
+    monthPlaceholder?: string;
+    /** 63/73 */
+    weekPlaceholder?: string;
+    /** 63/73 */
+    rangeYearPlaceholder?: [string, string];
+    /** 63/73 */
+    rangeMonthPlaceholder?: [string, string];
+    /** 55/73 */
+    rangeQuarterPlaceholder?: [string, string];
+    /** 63/73 */
+    rangeWeekPlaceholder?: [string, string];
+    /** 33/73 */
+    weekSelect?: string;
+    /** 16/73（`it_IT` / `mr_IN` / `pt_BR` / `pt_PT` / `tr_TR` 等） */
+    shortWeekDays?: string[];
+    /** 16/73 */
+    shortMonths?: string[];
+    /** 5/73 */
+    monthFormat?: string;
+    /** 4/73 */
+    cellDateFormat?: string;
+    /** 3/73 */
+    fieldDateFormat?: string;
+    /** 3/73 */
+    fieldDateTimeFormat?: string;
+    /** 1/73 */
+    fieldMonthFormat?: string;
+    /** 1/73 */
+    fieldWeekFormat?: string;
+}
+interface PickerLocale {
+    lang: PickerLangLocale;
+    timePickerLocale: TimePickerLocale;
+    /**
+     * 下面四个是上游保留的**已废弃**字段（），
+     * 官方注释写的是「Invalid, Please use `lang.field*Format` instead」。
+     * 本包的 73 个语言包**都没有**它们 —— 列在这里只为让类型与上游同构。
+     */
+    /** @deprecated 用 `lang.fieldDateFormat` */
+    dateFormat?: string;
+    /** @deprecated 用 `lang.fieldDateTimeFormat` */
+    dateTimeFormat?: string;
+    /** @deprecated 用 `lang.fieldWeekFormat` */
+    weekFormat?: string;
+    /** @deprecated 用 `lang.fieldWeekFormat` */
+    monthFormat?: string;
+}
+interface TableLocale {
+    filterTitle?: string;
+    filterConfirm?: VNodeChild;
+    filterReset?: VNodeChild;
+    filterEmptyText?: VNodeChild;
+    /** @deprecated 用 `filterCheckAll` */
+    filterCheckall?: VNodeChild;
+    filterCheckAll?: VNodeChild;
+    filterSearchPlaceholder?: string;
+    emptyText?: VNodeChild;
+    selectAll?: VNodeChild;
+    selectNone?: VNodeChild;
+    selectInvert?: VNodeChild;
+    selectionAll?: VNodeChild;
+    sortTitle?: string;
+    expand?: string;
+    collapse?: string;
+    triggerDesc?: string;
+    triggerAsc?: string;
+    cancelSort?: string;
+}
+interface ModalLocale {
+    okText: string;
+    cancelText: string;
+    justOkText: string;
+}
+interface TourLocale {
+    Next: string;
+    Previous: string;
+    Finish: string;
+}
+interface PopconfirmLocale {
+    okText: string;
+    cancelText: string;
+}
+interface TransferLocale {
+    titles?: VNodeChild[];
+    notFoundContent?: VNodeChild | VNodeChild[];
+    searchPlaceholder: string;
+    itemUnit: string;
+    itemsUnit: string;
+    remove?: string;
+    selectAll?: string;
+    deselectAll?: string;
+    selectCurrent?: string;
+    selectInvert?: string;
+    removeAll?: string;
+    removeCurrent?: string;
+}
+/** `Empty` 用的是它自己的 `TransferLocale`（同名不同义，只有一个 `description`）。 */
+interface EmptyLocale {
+    description: string;
+}
+interface UploadLocale {
+    uploading?: string;
+    removeFile?: string;
+    downloadFile?: string;
+    uploadError?: string;
+    previewFile?: string;
+}
+/** 所有组件共用的占位/提示文案。 */
+interface GlobalLocale {
+    clear?: string;
+    placeholder?: string;
+    close?: string;
+    sortable?: string;
+    show?: string;
+    hide?: string;
+}
+interface TextLocale {
+    edit?: VNodeChild;
+    copy?: VNodeChild;
+    copied?: VNodeChild;
+    expand?: VNodeChild;
+    collapse?: VNodeChild;
+}
+/**
+ * 表单校验消息模板。
+ *
+ * 上游来自 `@rc-component/form` 的 `ValidateMessages`。本包按数据形状重写：
+ * **所有字段都是可选的**（rc-form 允许局部覆盖），模板串里用 `${label}` / `${min}`
+ * 这类占位符。
+ */
+interface ValidateMessages {
+    default?: string;
+    required?: string;
+    enum?: string;
+    whitespace?: string;
+    date?: {
+        format?: string;
+        parse?: string;
+        invalid?: string;
+    };
+    types?: {
+        string?: string;
+        method?: string;
+        array?: string;
+        object?: string;
+        number?: string;
+        date?: string;
+        boolean?: string;
+        integer?: string;
+        float?: string;
+        regexp?: string;
+        email?: string;
+        url?: string;
+        hex?: string;
+    };
+    string?: {
+        len?: string;
+        min?: string;
+        max?: string;
+        range?: string;
+    };
+    number?: {
+        len?: string;
+        min?: string;
+        max?: string;
+        range?: string;
+    };
+    array?: {
+        len?: string;
+        min?: string;
+        max?: string;
+        range?: string;
+    };
+    pattern?: {
+        mismatch?: string;
+    };
+}
+interface FormLocale {
+    optional?: string;
+    defaultValidateMessages: ValidateMessages;
+}
+interface QRCodeLocale {
+    expired?: string;
+    refresh?: string;
+    scanned?: string;
+}
+interface CarouselLocale {
+    prevSlide: string;
+    nextSlide: string;
+}
+interface ColorPickerLocale {
+    presetEmpty: string;
+    transparent: string;
+    singleColor: string;
+    gradientColor: string;
+}
+/**
+ * 一个语言包。
+ *
+ * ⚠️ `locale` 是**唯一必填**字段，其余全部可选 —— 这让「只覆盖一部分分片」
+ * 成为合法用法（`ConfigProvider` 的 `locale` 就是被这样用的）。
+ *
+ * ⚠️ 两个容易看错的地方：
+ *   - `Select` 在类型里存在，但 **75 个语言包一个都没有它** ——
+ *     它是留给 `ConfigProvider` 消费方的口子，不是疏漏。
+ *   - `Carousel` / `ColorPicker` 的子字段是**必填**，与其它分片不同。照抄上游。
+ */
+interface Locale {
+    locale: string;
+    Pagination?: PaginationLocale;
+    DatePicker?: PickerLocale;
+    TimePicker?: TimePickerLocale;
+    Calendar?: PickerLocale;
+    Table?: TableLocale;
+    Modal?: ModalLocale;
+    Tour?: TourLocale;
+    Popconfirm?: PopconfirmLocale;
+    Transfer?: TransferLocale;
+    Select?: Record<string, unknown>;
+    Upload?: UploadLocale;
+    Empty?: EmptyLocale;
+    global?: GlobalLocale;
+    Icon?: Record<string, unknown>;
+    Text?: TextLocale;
+    Form?: FormLocale;
+    QRCode?: QRCodeLocale;
+    Carousel?: CarouselLocale;
+    ColorPicker?: ColorPickerLocale;
+}
+/** 分片名（`'locale'` 之外的全部键）。 */
+type LocaleComponentName = Exclude<keyof Locale, 'locale'>;
+
+/** Ordered global fallback sources for context-free Modal static services. */
+
+/**
+ * Bind a provider's Modal source during setup. Client mount order determines
+ * priority; replacement, deep edits and withdrawal retain that order. An absent
+ * source contributes no fields. SSR never registers request-local data.
+ */
+declare function useConfirmLocale(source: MaybeRefOrGetter<ModalLocale | undefined>): void;
+/**
+ * 注册一份 Modal locale。
+ *
+ * @param newLocale `undefined` 时清空全部来源并重置为英文默认值。
+ * @returns 反注册函数；`newLocale` 为空时返回 `undefined`
+ */
+declare function changeConfirmLocale(newLocale?: ModalLocale): (() => void) | undefined;
+/** 取当前生效的 Modal locale（`Modal.confirm` 用它）。 */
+declare function getConfirmLocale(): ModalLocale;
+/** 测试辅助：清空全部静态服务来源。生产代码不应调用。 */
+declare function resetConfirmLocale(): void;
+
+/**
+ * locale 的注入上下文。
+ *
+ * 契约来源：antd 6.6.4 的 `es/locale/context.js` —— `createContext(undefined)`。
+ * 默认值是 `undefined`（**不是空对象**），这一点很重要：`useLocale` 靠
+ * 「`fullLocale` 是不是 `undefined`」区分「没挂 Provider」与「挂了但没给这个分片」。
+ */
+
+/**
+ * context 的值：`Locale` 加上一个 `exist` 标志。
+ *
+ * ⚠️ `exist` 是 antd 的内部约定（`index.js:28` 的 `{...locale, exist: true}`），
+ *    唯一用途是让 `useLocale` 在「挂了 Provider 但没给 `locale` 字段」时
+ *    回退到 `'en'`（见 `use-locale.ts`）。
+ */
+/**
+ * ⚠️ 是 **Partial** —— `LocaleProvider` 的 `locale` prop 默认值是 `{}`，
+ *    注入出去的值就是 `{exist: true}`（没有 `locale` 字段）。
+ *    用完整的 `Locale` 会逼得每个只覆盖一个分片的调用方都要编造一个 `locale` 字符串。
+ */
+type LocaleContextValue = Partial<Locale> & {
+    exist?: boolean;
+};
+/**
+ * 注入键。
+ *
+ * ⚠️ 值的形态接受 `ComputedRef` / getter / 普通对象三种 —— `LocaleProvider`
+ *    提供的是 `ComputedRef`（这样 `locale` prop 变化能被追踪），但消费方直接
+ *    `provide` 一个普通对象也应当工作。`useLocale` 内部用 `toValue` 归一。
+ */
+type LocaleContextSource = MaybeRefOrGetter<LocaleContextValue | undefined>;
+declare const localeContextKey: InjectionKey<MaybeRefOrGetter<LocaleContextValue | undefined>>;
+
+declare const ANT_MARK = "internalMark";
+/** 测试辅助：清空告警去重表。生产代码不应调用。 */
+declare function resetLocaleWarned(): void;
+declare const LocaleProvider: vue.DefineComponent<vue.ExtractPropTypes<{
+    locale: {
+        type: PropType<Partial<Locale>>;
+        default: () => {};
+    };
+    /** 上游用它判断「是不是官方导出的那个组件」 */
+    _ANT_MARK__: {
+        type: StringConstructor;
+        default: undefined;
+    };
+}>, () => VNodeChild, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    locale: {
+        type: PropType<Partial<Locale>>;
+        default: () => {};
+    };
+    /** 上游用它判断「是不是官方导出的那个组件」 */
+    _ANT_MARK__: {
+        type: StringConstructor;
+        default: undefined;
+    };
+}>> & Readonly<{}>, {
+    locale: Partial<Locale>;
+    _ANT_MARK__: string;
+}, SlotsType<{
+    default?: () => VNodeChild;
+}>, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+declare const localeValues$18: Locale;
+
+declare const localeValues$17: Locale;
+
+declare const localeValues$16: Locale;
+
+declare const localeValues$15: Locale;
+
+declare const localeValues$14: Locale;
+
+declare const localeValues$13: Locale;
+
+declare const localeValues$12: Locale;
+
+declare const localeValues$11: Locale;
+
+declare const localeValues$10: Locale;
+
+declare const localeValues$$: Locale;
+
+declare const localeValues$_: Locale;
+
+declare const localeValues$Z: Locale;
+
+declare const localeValues$Y: Locale;
+
+declare const localeValues$X: Locale;
+
+declare const localeValues$W: Locale;
+
+declare const localeValues$V: Locale;
+
+declare const localeValues$U: Locale;
+
+declare const localeValues$T: Locale;
+
+declare const localeValues$S: Locale;
+
+declare const localeValues$R: Locale;
+
+declare const localeValues$Q: Locale;
+
+declare const localeValues$P: Locale;
+
+declare const localeValues$O: Locale;
+
+declare const localeValues$N: Locale;
+
+declare const localeValues$M: Locale;
+
+declare const localeValues$L: Locale;
+
+declare const localeValues$K: Locale;
+
+declare const localeValues$J: Locale;
+
+declare const localeValues$I: Locale;
+
+declare const localeValues$H: Locale;
+
+declare const localeValues$G: Locale;
+
+declare const localeValues$F: Locale;
+
+declare const localeValues$E: Locale;
+
+declare const localeValues$D: Locale;
+
+declare const localeValues$C: Locale;
+
+declare const localeValues$B: Locale;
+
+declare const localeValues$A: Locale;
+
+declare const localeValues$z: Locale;
+
+declare const localeValues$y: Locale;
+
+declare const localeValues$x: Locale;
+
+declare const localeValues$w: Locale;
+
+declare const localeValues$v: Locale;
+
+declare const localeValues$u: Locale;
+
+declare const localeValues$t: Locale;
+
+declare const localeValues$s: Locale;
+
+declare const localeValues$r: Locale;
+
+declare const localeValues$q: Locale;
+
+declare const localeValues$p: Locale;
+
+declare const localeValues$o: Locale;
+
+declare const localeValues$n: Locale;
+
+declare const localeValues$m: Locale;
+
+declare const localeValues$l: Locale;
+
+declare const localeValues$k: Locale;
+
+declare const localeValues$j: Locale;
+
+declare const localeValues$i: Locale;
+
+declare const localeValues$h: Locale;
+
+declare const localeValues$g: Locale;
+
+declare const localeValues$f: Locale;
+
+declare const localeValues$e: Locale;
+
+declare const localeValues$d: Locale;
+
+declare const localeValues$c: Locale;
+
+declare const localeValues$b: Locale;
+
+declare const localeValues$a: Locale;
+
+declare const localeValues$9: Locale;
+
+declare const localeValues$8: Locale;
+
+declare const localeValues$7: Locale;
+
+declare const localeValues$6: Locale;
+
+declare const localeValues$5: Locale;
+
+declare const localeValues$4: Locale;
+
+declare const localeValues$3: Locale;
+
+declare const localeValues$2: Locale;
+
+declare const localeValues$1: Locale;
+
+declare const localeValues: Locale;
+
+/** 兜底数据（上游的 `defaultLocaleData`）。 */
+declare const defaultLocaleData: Locale;
+/**
+ * Current component locale and language code. Read both computed refs inside
+ * render/computed (or unwrap them in templates) to follow provider updates.
+ * Component fragments merge shallowly; context values override defaults.
+ */
+declare function useLocale<C extends LocaleComponentName>(componentName: C, defaultLocale?: Locale[C] | (() => Locale[C])): readonly [ComputedRef<NonNullable<Locale[C]>>, ComputedRef<string | undefined>];
+
+export { ANT_MARK, LocaleProvider, localeValues$18 as ar_EG, localeValues$17 as az_AZ, localeValues$16 as bg_BG, localeValues$15 as bn_BD, localeValues$14 as by_BY, localeValues$13 as ca_ES, changeConfirmLocale, localeValues$12 as cs_CZ, localeValues$11 as da_DK, localeValues$10 as de_DE, localeValues$Z as defaultLocale, defaultLocaleData, localeValues$$ as el_GR, localeValues$_ as en_GB, localeValues$Z as en_US, localeValues$Y as es_ES, localeValues$X as es_US, localeValues$W as et_EE, localeValues$V as eu_ES, localeValues$U as fa_IR, localeValues$T as fi_FI, localeValues$S as fr_BE, localeValues$R as fr_CA, localeValues$Q as fr_FR, localeValues$P as ga_IE, getConfirmLocale, localeValues$O as gl_ES, localeValues$N as he_IL, localeValues$M as hi_IN, localeValues$L as hr_HR, localeValues$K as hu_HU, localeValues$J as hy_AM, localeValues$I as id_ID, localeValues$H as is_IS, localeValues$G as it_IT, localeValues$F as ja_JP, localeValues$E as ka_GE, localeValues$D as kk_KZ, localeValues$C as km_KH, localeValues$B as kmr_IQ, localeValues$A as kn_IN, localeValues$z as ko_KR, localeValues$y as ku_IQ, localeContextKey, localeValues$x as lt_LT, localeValues$w as lv_LV, localeValues$v as mk_MK, localeValues$u as ml_IN, localeValues$t as mn_MN, localeValues$s as mr_IN, localeValues$r as ms_MY, localeValues$q as my_MM, localeValues$p as nb_NO, localeValues$o as ne_NP, localeValues$n as nl_BE, localeValues$m as nl_NL, localeValues$l as pl_PL, localeValues$k as pt_BR, localeValues$j as pt_PT, resetConfirmLocale, resetLocaleWarned, localeValues$i as ro_RO, localeValues$h as ru_RU, localeValues$g as si_LK, localeValues$f as sk_SK, localeValues$e as sl_SI, localeValues$d as sq_AL, localeValues$c as sr_RS, localeValues$b as sv_SE, localeValues$a as ta_IN, localeValues$9 as th_TH, localeValues$8 as tk_TK, localeValues$7 as tr_TR, localeValues$6 as uk_UA, localeValues$5 as ur_PK, useConfirmLocale, useLocale, localeValues$4 as uz_UZ, localeValues$3 as vi_VN, localeValues$2 as zh_CN, localeValues$1 as zh_HK, localeValues as zh_TW };
+export type { CarouselLocale, ColorPickerLocale, EmptyLocale, FormLocale, GlobalLocale, Locale, LocaleComponentName, LocaleContextSource, LocaleContextValue, ModalLocale, PaginationLocale, PickerLangLocale, PickerLocale, PopconfirmLocale, QRCodeLocale, TableLocale, TextLocale, TimePickerLocale, TourLocale, TransferLocale, UploadLocale, ValidateMessages };