TanTan
e311ca3275
Build NapCat Artifacts / Windows Loader Test (push) Canceled after 0s
Build NapCat Artifacts / Type Check & Test (push) Canceled after 0s
Build NapCat Artifacts / Build NapCat.Framework (push) Canceled after 0s
Build NapCat Artifacts / Build NapCat.Shell (push) Canceled after 0s
125 lines
3.8 KiB
Plaintext
125 lines
3.8 KiB
Plaintext
import type { UnknownAction } from '@reduxjs/toolkit'
|
|
import type { BaseQueryFn } from './baseQueryTypes'
|
|
import type { CombinedState, CoreModule, QueryKeys } from './core'
|
|
import type { ApiModules } from './core/module'
|
|
import type { CreateApiOptions } from './createApi'
|
|
import type {
|
|
EndpointBuilder,
|
|
EndpointDefinition,
|
|
EndpointDefinitions,
|
|
UpdateDefinitions,
|
|
} from './endpointDefinitions'
|
|
import type {
|
|
NoInfer,
|
|
UnionToIntersection,
|
|
WithRequiredProp,
|
|
} from './tsHelpers'
|
|
|
|
export type ModuleName = keyof ApiModules<any, any, any, any>
|
|
|
|
export type Module<Name extends ModuleName> = {
|
|
name: Name
|
|
init<
|
|
BaseQuery extends BaseQueryFn,
|
|
Definitions extends EndpointDefinitions,
|
|
ReducerPath extends string,
|
|
TagTypes extends string,
|
|
>(
|
|
api: Api<BaseQuery, EndpointDefinitions, ReducerPath, TagTypes, ModuleName>,
|
|
options: WithRequiredProp<
|
|
CreateApiOptions<BaseQuery, Definitions, ReducerPath, TagTypes>,
|
|
| 'reducerPath'
|
|
| 'serializeQueryArgs'
|
|
| 'keepUnusedDataFor'
|
|
| 'refetchOnMountOrArgChange'
|
|
| 'refetchOnFocus'
|
|
| 'refetchOnReconnect'
|
|
| 'invalidationBehavior'
|
|
| 'tagTypes'
|
|
>,
|
|
context: ApiContext<Definitions>,
|
|
): {
|
|
injectEndpoint(
|
|
endpointName: string,
|
|
definition: EndpointDefinition<any, any, any, any>,
|
|
): void
|
|
}
|
|
}
|
|
|
|
export interface ApiContext<Definitions extends EndpointDefinitions> {
|
|
apiUid: string
|
|
endpointDefinitions: Definitions
|
|
batch(cb: () => void): void
|
|
extractRehydrationInfo: (
|
|
action: UnknownAction,
|
|
) => CombinedState<any, any, any> | undefined
|
|
hasRehydrationInfo: (action: UnknownAction) => boolean
|
|
}
|
|
|
|
export const getEndpointDefinition = <
|
|
Definitions extends EndpointDefinitions,
|
|
EndpointName extends keyof Definitions,
|
|
>(
|
|
context: ApiContext<Definitions>,
|
|
endpointName: EndpointName,
|
|
) => context.endpointDefinitions[endpointName]
|
|
|
|
export type Api<
|
|
BaseQuery extends BaseQueryFn,
|
|
Definitions extends EndpointDefinitions,
|
|
ReducerPath extends string,
|
|
TagTypes extends string,
|
|
Enhancers extends ModuleName = CoreModule,
|
|
> = UnionToIntersection<
|
|
ApiModules<BaseQuery, Definitions, ReducerPath, TagTypes>[Enhancers]
|
|
> & {
|
|
/**
|
|
* A function to inject the endpoints into the original API, but also give you that same API with correct types for these endpoints back. Useful with code-splitting.
|
|
*/
|
|
injectEndpoints<NewDefinitions extends EndpointDefinitions>(_: {
|
|
endpoints: (
|
|
build: EndpointBuilder<BaseQuery, TagTypes, ReducerPath>,
|
|
) => NewDefinitions
|
|
/**
|
|
* Optionally allows endpoints to be overridden if defined by multiple `injectEndpoints` calls.
|
|
*
|
|
* If set to `true`, will override existing endpoints with the new definition.
|
|
* If set to `'throw'`, will throw an error if an endpoint is redefined with a different definition.
|
|
* If set to `false` (or unset), will not override existing endpoints with the new definition, and log a warning in development.
|
|
*/
|
|
overrideExisting?: boolean | 'throw'
|
|
}): Api<
|
|
BaseQuery,
|
|
Definitions & NewDefinitions,
|
|
ReducerPath,
|
|
TagTypes,
|
|
Enhancers
|
|
>
|
|
/**
|
|
*A function to enhance a generated API with additional information. Useful with code-generation.
|
|
*/
|
|
enhanceEndpoints<
|
|
NewTagTypes extends string = never,
|
|
NewDefinitions extends EndpointDefinitions = never,
|
|
>(_: {
|
|
addTagTypes?: readonly NewTagTypes[]
|
|
endpoints?: UpdateDefinitions<
|
|
Definitions,
|
|
TagTypes | NoInfer<NewTagTypes>,
|
|
NewDefinitions
|
|
> extends infer NewDefinitions
|
|
? {
|
|
[K in keyof NewDefinitions]?:
|
|
| Partial<NewDefinitions[K]>
|
|
| ((definition: NewDefinitions[K]) => void)
|
|
}
|
|
: never
|
|
}): Api<
|
|
BaseQuery,
|
|
UpdateDefinitions<Definitions, TagTypes | NewTagTypes, NewDefinitions>,
|
|
ReducerPath,
|
|
TagTypes | NewTagTypes,
|
|
Enhancers
|
|
>
|
|
}
|