From 0094ff7babab6839ccef4c82fa46b8aa4f14198f Mon Sep 17 00:00:00 2001 From: toasted-nutbread Date: Wed, 27 Dec 2023 01:40:25 -0500 Subject: API map updates (#458) * Rename * Fix incorrect union types * Update type names * Fix types --- types/ext/api-map.d.ts | 4 ++-- types/ext/api.d.ts | 4 ++-- types/ext/offscreen.d.ts | 33 ++++++++++++++++++++------------- 3 files changed, 24 insertions(+), 17 deletions(-) (limited to 'types/ext') diff --git a/types/ext/api-map.d.ts b/types/ext/api-map.d.ts index 4a4eb87c..8c3215cf 100644 --- a/types/ext/api-map.d.ts +++ b/types/ext/api-map.d.ts @@ -109,7 +109,7 @@ export type ApiFunctionOrdered Promise>; /** Type alias for a union of all params types. */ -export type ApiParamsAny = ApiParams; +export type ApiParamsAny = {[name in ApiNames]: ApiParams}[ApiNames]; /** Type alias for a union of all return types. */ -export type ApiReturnAny = ApiReturn; +export type ApiReturnAny = {[name in ApiNames]: ApiReturn}[ApiNames]; diff --git a/types/ext/api.d.ts b/types/ext/api.d.ts index 2d23040c..ad3aa22c 100644 --- a/types/ext/api.d.ts +++ b/types/ext/api.d.ts @@ -399,9 +399,9 @@ export type ApiReturn = BaseApiReturn export type ApiParamsAny = BaseApiParamsAny; -export type MessageAny = Message; +export type ApiMessageAny = {[name in ApiNames]: ApiMessage}[ApiNames]; -type Message = { +type ApiMessage = { action: TName; params: ApiParams; }; diff --git a/types/ext/offscreen.d.ts b/types/ext/offscreen.d.ts index 511c32bd..9b1d844a 100644 --- a/types/ext/offscreen.d.ts +++ b/types/ext/offscreen.d.ts @@ -22,9 +22,16 @@ import type * as DictionaryImporter from './dictionary-importer'; import type * as Environment from './environment'; import type * as Translation from './translation'; import type * as Translator from './translator'; -import type {ApiMap, ApiMapInit, ApiHandler, ApiParams, ApiReturn, ApiNames} from './api-map'; +import type { + ApiMap as BaseApiMap, + ApiMapInit as BaseApiMapInit, + ApiHandler as BaseApiHandler, + ApiParams as BaseApiParams, + ApiReturn as BaseApiReturn, + ApiNames as BaseApiNames, +} from './api-map'; -type OffscreenApiSurface = { +type ApiSurface = { databasePrepareOffscreen: { params: void; return: void; @@ -93,13 +100,13 @@ type OffscreenApiSurface = { }; }; -export type Message = ( - OffscreenApiParams extends void ? - {action: TName} : - {action: TName, params: OffscreenApiParams} +export type ApiMessage = ( + ApiParams extends void ? + {action: TName, params?: never} : + {action: TName, params: ApiParams} ); -export type MessageType = ApiNames; +export type ApiNames = BaseApiNames; export type FindKanjiOptionsOffscreen = Omit & { enabledDictionaryMap: [ @@ -121,14 +128,14 @@ export type FindTermsTextReplacementOffscreen = Omit; +export type ApiMap = BaseApiMap; -export type OffscreenApiMapInit = ApiMapInit; +export type ApiMapInit = BaseApiMapInit; -export type OffscreenApiHandler = ApiHandler; +export type ApiHandler = BaseApiHandler; -export type OffscreenApiParams = ApiParams; +export type ApiParams = BaseApiParams; -export type OffscreenApiReturn = ApiReturn; +export type ApiReturn = BaseApiReturn; -export type MessageAny = Message; +export type ApiMessageAny = {[name in ApiNames]: ApiMessage}[ApiNames]; -- cgit v1.2.3