Skip to content

feat!: support resource schema type definition for @intlfy/core-base (@intlify/core) #1594

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 18, 2023
Merged

feat!: support resource schema type definition for @intlfy/core-base (@intlify/core) #1594

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 36 additions & 3 deletions packages/core-base/src/context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,9 @@ import type {
SchemaParams,
LocaleParams,
PickupLocales,
FallbackLocales
FallbackLocales,
IsEmptyObject,
RemoveIndexSignature
} from './types'
import type { LocaleFallbacker } from './fallbacker'

Expand Down Expand Up @@ -91,6 +93,37 @@ export type LocaleMessages<
Message = string // eslint-disable-line @typescript-eslint/no-unused-vars
> = LocaleRecord<UnionToTuple<Locales>, Schema>

/**
* The type definition of Locale Message for `@intlify/core-base` package
*
* @remarks
* The typealias is used to strictly define the type of the Locale message.
*
* @example
* ```ts
* // type.d.ts (`.d.ts` file at your app)
* import { DefineCoreLocaleMessage } from '@intlify/core-base'
*
* declare module '@intlify/core-base' {
* export interface DefineCoreLocaleMessage {
* title: string
* menu: {
* login: string
* }
* }
* }
* ```
*
* @VueI18nGeneral
*/
export interface DefineCoreLocaleMessage extends LocaleMessage<string> {} // eslint-disable-line @typescript-eslint/no-empty-interface

export type DefaultCoreLocaleMessageSchema<
Schema = RemoveIndexSignature<{
[K in keyof DefineCoreLocaleMessage]: DefineCoreLocaleMessage[K]
}>
> = IsEmptyObject<Schema> extends true ? LocaleMessage<string> : Schema

export type CoreMissingHandler<Message = string> = (
context: CoreContext<Message>,
locale: Locale,
Expand Down Expand Up @@ -155,7 +188,7 @@ export interface CoreOptions<
datetime?: unknown
number?: unknown
} = {
message: LocaleMessage<Message>,
message: DefaultCoreLocaleMessageSchema,
datetime: DateTimeFormat,
number: NumberFormat
},
Expand All @@ -181,7 +214,7 @@ export interface CoreOptions<
: Locales extends string
? Locales
: Locale,
MessageSchema = Schema extends { message: infer M } ? M : LocaleMessage<Message>,
MessageSchema = Schema extends { message: infer M } ? M : DefaultCoreLocaleMessageSchema,
DateTimeSchema = Schema extends { datetime: infer D } ? D : DateTimeFormat,
NumberSchema = Schema extends { number: infer N } ? N : NumberFormat,
_Messages extends LocaleMessages<
Expand Down
Loading