@pgcorp/ui-kit 0.9.0 → 0.10.0

package/src/locales/locale.ts

@@ -0,0 +1,472 @@
+/** Supported UI-kit locales. */
+export const UI_KIT_LOCALES = ['en', 'ru', 'zh-CN', 'zh-TW'] as const
+
+/** Locale identifier owned by one Vue application subtree. */
+export type UiKitLocale = (typeof UI_KIT_LOCALES)[number]
+
+/**
+ * Complete schema for text owned by UI-kit controls.
+ * Domain content supplied by consumers is intentionally outside this schema.
+ */
+export interface UiKitMessages {
+  actions: {
+    close: string
+    dismiss: string
+    copy: string
+    retry: string
+    expand: string
+    collapse: string
+    select: string
+    deselect: string
+    selectAll: string
+    clearSelection: string
+    refresh: string
+    search: string
+    previous: string
+    next: string
+    removeChip: string
+  }
+  clipboard: {
+    copy: string
+    copied: string
+    copyErrorTitle: string
+    copyCode: string
+    codeCopied: string
+    codeCopyUnavailable: string
+    clipboardUnavailable: string
+    codeCopyFailed: string
+    valueCopyFailed: string
+    documentCopyFailed: string
+    textCopyFailed: string
+    emptyCode: string
+    valueCopied: string
+    emptyValue: string
+    copyDocument: string
+    documentCopied: string
+    emptyDocument: string
+    copyText: string
+    textCopied: string
+    emptyText: string
+  }
+  feedback: {
+    loading: string
+    empty: string
+    error: string
+    unknown: string
+    notifications: string
+    closeNotification: string
+    dismissMessage: string
+    titleStatus: string
+    titleInformation: string
+    titleSuccess: string
+    titleWarning: string
+    titleError: string
+    titleRunning: string
+    serverResponseError: string
+    request: string
+    openLinkFailed: string
+  }
+  dialog: {
+    close: string
+    drawer: string
+    modal: string
+    moreActions: string
+  }
+  layout: {
+    resizeBottomPanel: string
+    resizeLeftPanel: string
+    resizeRightPanel: string
+    resizeSidePanel: string
+    dragActive: string
+    dragIdle: string
+  }
+  navigation: {
+    main: string
+    breadcrumbs: string
+    tabs: string
+    tabActions: string
+    wizardSteps: string
+    catalog: string
+    found: string
+    of: string
+    group: string
+    sort: string
+    catalogItems: string
+    allGroups: string
+    sortNameAscending: string
+    sortNameDescending: string
+    sortId: string
+    noResults: string
+  }
+  forms: {
+    selectPlaceholder: string
+    searchPlaceholder: string
+    noOptions: string
+    addToContext: string
+    removeFromContext: string
+    openToken: string
+    removeToken: string
+  }
+  kanban: { empty: string }
+  tree: {
+    expandNode: string
+    collapseNode: string
+    selectNode: string
+    deselectNode: string
+  }
+  table: {
+    accessibleName: string
+    rowDetails: string
+    detailsFor: string
+    selectAllRows: string
+    clearAllRows: string
+    selectRow: string
+    deselectRow: string
+    selectionUnavailable: string
+    expandRow: string
+    collapseRow: string
+    loading: string
+    empty: string
+    dataGridLoading: string
+    dataGridEmpty: string
+    sortAscending: string
+    sortDescending: string
+    clearSort: string
+    sortPriority: string
+    ascending: string
+    descending: string
+    addSortAscending: string
+    sortNextDescending: string
+    removeFromSort: string
+    multiSortSummary: string
+    rowLabel: string
+  }
+  editor: {
+    codeBlock: string
+    documentBlock: string
+    loading: string
+    search: string
+    noSearchResults: string
+    previousMatch: string
+    nextMatch: string
+    closeSearch: string
+    matchPosition: string
+    find: string
+    replace: string
+    nextMatchShort: string
+    previousMatchShort: string
+    selectAllMatches: string
+    matchCase: string
+    regularExpression: string
+    wholeWord: string
+    replaceOne: string
+    replaceAll: string
+    sqlLoading: string
+    sqlPlaceholder: string
+    diagnosticsCount: string
+    plainText: string
+    workspaceEmpty: string
+    closeDocument: string
+    diffBefore: string
+    diffAfter: string
+    diffComputing: string
+    diffNoChanges: string
+    diffExpandGap: string
+    diffCollapseGap: string
+    diffMissingLineBreak: string
+    diffSummary: string
+    diffUnchangedLine: string
+    diffRemovedLine: string
+    diffAddedLine: string
+    mathLoading: string
+    mathError: string
+  }
+  chart: {
+    accessibleName: string
+    empty: string
+    category: string
+    dataFor: string
+    noNonZeroValues: string
+  }
+  graph: {
+    invalidData: string
+    webglRequired: string
+    renderFailed: string
+    themeFailed: string
+  }
+  data: {
+    emptyKey: string
+    linkedSystems: string
+    jsonStructure: string
+  }
+  persona: {
+    projectPicker: string
+    runConsole: string
+    runLog: string
+    noProjects: string
+    noEvents: string
+    statusUnknown: string
+    projectTitle: string
+    discoveryTitle: string
+    catalogTitle: string
+    structureTitle: string
+    selectedTestTitle: string
+    runSelected: string
+    runAll: string
+    discover: string
+    watch: string
+    searchTests: string
+    noCatalogTests: string
+    emptyStructure: string
+    runListTitle: string
+    selectedRunTitle: string
+    itemsTitle: string
+    eventsTitle: string
+    loadMoreRuns: string
+    loadMoreItems: string
+    appendEvents: string
+    loadMoreEvents: string
+    refreshEvents: string
+    cancelRun: string
+    reportSummary: string
+    emptyRun: string
+    noRuns: string
+    noItems: string
+    noRunEvents: string
+    loadingCatalog: string
+    loadingRuns: string
+    loadingItems: string
+    loadingEvents: string
+    openRun: string
+    artifacts: string
+    projectDiagnostics: string
+    diagnosticOverview: string
+    diagnosticSearch: string
+    diagnosticImportance: string
+    diagnosticMessages: string
+    diagnosticNoResults: string
+    showAllMessages: string
+    showErrors: string
+    showWarnings: string
+    allCount: string
+    errorsCount: string
+    warningsCount: string
+    unavailableScenarios: string
+    componentAnalysisErrors: string
+    pageObjectQualityIssues: string
+    unclassifiedMessages: string
+    messageOne: string
+    messageFew: string
+    messageMany: string
+    availableOne: string
+    availableFew: string
+    availableMany: string
+    unavailableOne: string
+    unavailableFew: string
+    unavailableMany: string
+    componentOne: string
+    componentFew: string
+    componentMany: string
+    pageOne: string
+    pageFew: string
+    pageMany: string
+    errorOne: string
+    errorFew: string
+    errorMany: string
+    warningOne: string
+    warningFew: string
+    warningMany: string
+    selectTest: string
+    linkedTestMaterials: string
+    pickerTitle: string
+    connected: string
+    connectedProjects: string
+    active: string
+    open: string
+    selected: string
+    select: string
+    openProject: string
+    selectArea: string
+    projectSearchArea: string
+    searchCurrentCatalog: string
+    catalogSearch: string
+    refreshCatalog: string
+    catalogPath: string
+    directoriesAndProjects: string
+    personaProject: string
+    noAccess: string
+    projectError: string
+    openDirectory: string
+    loadingCatalogs: string
+    chooseSearchArea: string
+    noMatches: string
+    noNestedDirectories: string
+    adjustSearch: string
+    chooseAnotherArea: string
+    loadMore: string
+    cancel: string
+    connectProject: string
+    diagnosticError: string
+    diagnosticWarning: string
+    diagnosticInformation: string
+    scenarioNotImported: string
+    fixInTestProject: string
+    scenarioUnavailable: string
+    restoreScenarioImport: string
+    componentNotAnalyzed: string
+    relatedStructureIncomplete: string
+    restoreComponentImport: string
+    movePageObject: string
+    giveStableName: string
+    pageObjectQuality: string
+    doesNotBlockScenarios: string
+    unclassifiedPersonaMessage: string
+    personaClassificationRequired: string
+    impactUnspecified: string
+    personaMustClassify: string
+    overviewAvailable: string
+    overviewScenarioImports: string
+    overviewComponentAnalysis: string
+    overviewSupportQuality: string
+    statusCancelled: string
+    statusCancelling: string
+    statusCompleted: string
+    statusDegraded: string
+    statusError: string
+    statusPassed: string
+    statusPaused: string
+    statusQueued: string
+    statusRunning: string
+    statusSkipped: string
+    statusTimedOut: string
+    semanticAction: string
+    semanticCombinedStep: string
+    semanticExpectation: string
+    semanticFact: string
+    semanticGoal: string
+    semanticOps: string
+    semanticStep: string
+    semanticGet: string
+    semanticPersonaCall: string
+    requiredParameter: string
+    severityBlocker: string
+    severityCritical: string
+    severityMinor: string
+    severityNormal: string
+    severityTrivial: string
+    reportBroken: string
+    lifecycleAfterScenario: string
+    lifecycleAfterTest: string
+    lifecycleBeforeScenario: string
+    lifecycleBeforeTest: string
+    eventRunCancelled: string
+    eventRunCompleted: string
+    eventRunFailed: string
+    eventRuntimeMessage: string
+    eventRunQueued: string
+    eventRunStarted: string
+    eventRunTimedOut: string
+    eventTestQueued: string
+    eventTestCancelled: string
+    eventTestFinished: string
+    eventTestStarted: string
+    eventWorkerStarted: string
+    eventWorkerStopped: string
+    durationUnknown: string
+    durationMilliseconds: string
+    durationSeconds: string
+  }
+  theme: {
+    classic: string
+    pink: string
+    green: string
+    light: string
+    dark: string
+    variantLight: string
+    variantDark: string
+  }
+}
+
+type DeepPartial<T> = {
+  readonly [Key in keyof T]?: T[Key] extends string ? string : DeepPartial<T[Key]>
+}
+
+/** Exact-at-runtime deep override accepted by a locale provider. */
+export type UiKitMessagesOverride = DeepPartial<UiKitMessages>
+
+type LeafPath<T, Prefix extends string = ''> = {
+  [Key in keyof T & string]: T[Key] extends string
+    ? `${Prefix}${Key}`
+    : LeafPath<T[Key], `${Prefix}${Key}.`>
+}[keyof T & string]
+
+/** Dot-separated key for every leaf in {@link UiKitMessages}. */
+export type UiKitMessageKey = LeafPath<UiKitMessages>
+
+/** Parameter contracts for messages containing interpolation placeholders. */
+export interface UiKitMessageParameters {
+  'actions.removeChip': { readonly label: string }
+  'feedback.openLinkFailed': { readonly href: string }
+  'layout.dragActive': { readonly label: string }
+  'layout.dragIdle': { readonly label: string }
+  'forms.openToken': { readonly label: string }
+  'forms.removeToken': { readonly label: string }
+  'tree.expandNode': { readonly label: string }
+  'tree.collapseNode': { readonly label: string }
+  'tree.selectNode': { readonly label: string }
+  'tree.deselectNode': { readonly label: string }
+  'table.detailsFor': { readonly label: string }
+  'table.selectRow': { readonly label: string }
+  'table.deselectRow': { readonly label: string }
+  'table.selectionUnavailable': { readonly label: string }
+  'table.expandRow': { readonly label: string }
+  'table.collapseRow': { readonly label: string }
+  'table.sortAscending': { readonly column: string }
+  'table.sortDescending': { readonly column: string }
+  'table.clearSort': { readonly column: string }
+  'table.sortPriority': { readonly priority: number }
+  'table.addSortAscending': { readonly column: string }
+  'table.multiSortSummary': {
+    readonly column: string
+    readonly priority: number
+    readonly total: number
+    readonly direction: string
+    readonly action: string
+  }
+  'table.rowLabel': { readonly index: number }
+  'editor.matchPosition': { readonly current: number; readonly total: number }
+  'editor.diagnosticsCount': { readonly count: number }
+  'editor.closeDocument': { readonly name: string }
+  'editor.diffExpandGap': { readonly count: number }
+  'editor.diffCollapseGap': { readonly count: number }
+  'editor.diffSummary': { readonly added: number; readonly removed: number }
+  'editor.diffUnchangedLine': { readonly before: number | string; readonly after: number | string }
+  'editor.diffRemovedLine': { readonly line: number | string }
+  'editor.diffAddedLine': { readonly line: number | string }
+  'navigation.catalogItems': { readonly catalog: string }
+  'chart.dataFor': { readonly chart: string }
+  'theme.variantLight': { readonly family: string }
+  'theme.variantDark': { readonly family: string }
+  'persona.openRun': { readonly title: string }
+  'persona.allCount': { readonly count: number }
+  'persona.errorsCount': { readonly count: number }
+  'persona.warningsCount': { readonly count: number }
+  'persona.selectTest': { readonly title: string }
+  'persona.openProject': { readonly title: string }
+  'persona.openDirectory': { readonly name: string }
+  'persona.overviewAvailable': { readonly available: number; readonly total: number }
+  'persona.overviewScenarioImports': { readonly count: number }
+  'persona.overviewComponentAnalysis': { readonly count: number }
+  'persona.overviewSupportQuality': { readonly count: number }
+  'persona.durationMilliseconds': { readonly value: number }
+  'persona.durationSeconds': { readonly value: string }
+}
+
+export type UiKitParameterizedMessageKey = keyof UiKitMessageParameters
+export type UiKitStaticMessageKey = Exclude<UiKitMessageKey, UiKitParameterizedMessageKey>
+
+/** Strict translator: parameterized keys require exact parameters; static keys accept none. */
+export interface UiKitTranslate {
+  <Key extends UiKitStaticMessageKey>(key: Key): string
+  <Key extends UiKitParameterizedMessageKey>(key: Key, parameters: UiKitMessageParameters[Key]): string
+}