@ryo-98/react-api-bridge/dist/types.d.ts

A registry for component imperative api

import { RefObject } from "react";
export interface APIOptions {
    isMulti?: boolean;
}
export type UnifyToBoolean<T> = T extends true ? true : false;
export type MapMulti<O extends BridgeAPIOptions<APIParams>, N extends keyof O> = NonNullable<O[N]>['isMulti'];
export type ConditionByIsMulti<O extends BridgeAPIOptions<APIParams>, N extends keyof O, X1, X2> = MapMulti<O, N> extends true ? X1 : X2;
export type ResolveAPI<A extends APIParams, O extends BridgeAPIOptions<A>, N extends keyof A> = ConditionByIsMulti<O, N, RefObject<A[N]>[], RefObject<A[N]>>;
export type Bridge<A extends APIParams, O extends BridgeAPIOptions<A> = BridgeAPIOptions<A>> = {
    [N in keyof A]?: {
        options?: O[N];
        apiNList?: ResolveAPI<A, O, N>;
    };
};
export type BoundaryContextValue<A extends APIParams, P = any, O extends BridgeAPIOptions<A> = BridgeAPIOptions<A>> = {
    bridge: Bridge<A, O>;
    parent?: BoundaryContextValue<A, P, O>;
    payload: P;
};
export type BoundaryProps<A extends APIParams, P = any, O extends BridgeAPIOptions<A> = BridgeAPIOptions<A>> = undefined extends P ? {
    contextValue?: BoundaryContextValue<A, P, O>;
    payload?: P;
} : ({
    payload: P;
    contextValue?: BoundaryContextValue<A, P, O>;
} | {
    contextValue: BoundaryContextValue<A, P, O>;
    payload?: P;
});
export type BoundaryAPI<A extends APIParams, O extends BridgeAPIOptions<A> = BridgeAPIOptions<A>, P = any> = {
    payload: P;
    getAPI: <N extends keyof A>(name: N) => ResolveAPI<A, O, N>;
    parent: BoundaryContextValue<A, P, O> | undefined;
};
export type OnInit<A extends APIParams, N extends keyof A> = (api: RefObject<A[N]>) => any;
export type OnMultiInit<A extends APIParams, N extends keyof A> = (api: RefObject<A[N]> | undefined, total: RefObject<A[N]>[]) => any;
export type ResolveInit<A extends APIParams, O extends BridgeAPIOptions<A>, N extends keyof A> = ConditionByIsMulti<O, N, OnMultiInit<A, N>, OnInit<A, N>>;
export type BridgeAPIOptions<A extends APIParams> = Partial<Record<keyof A, APIOptions>>;
export type APIParams = Record<string, any>;
export interface BaseOptions<A extends APIParams, O extends BridgeAPIOptions<A> = BridgeAPIOptions<A>, P = any> {
    contextValue?: BoundaryContextValue<A, P, O>;
}
export interface GetAPIOptions<A extends APIParams, N extends keyof A, O extends BridgeAPIOptions<A>, P = any> extends BaseOptions<A, O, P> {
    onInit?: ResolveInit<A, O, N>;
}
export type AllAPI<A extends APIParams, O extends BridgeAPIOptions<A> = BridgeAPIOptions<A>> = {
    [N in keyof A]?: ResolveAPI<A, O, N> | undefined;
};
export interface UpperOptions<A extends APIParams, O extends BridgeAPIOptions<A> = BridgeAPIOptions<A>, P = any> extends BaseOptions<A, O, P> {
    shouldForwardYield?: (boundaryDetail: Pick<BoundaryContextValue<A, P, O>, 'payload' | 'parent'> & {
        allAPI: AllAPI<A, O>;
    }) => any;
}
export interface GetUpperAPIOptions<A extends APIParams, N extends keyof A, O extends BridgeAPIOptions<A>, P = any> extends GetAPIOptions<A, N, O, P>, UpperOptions<A, O, P> {
}
export interface GetAPIAsyncOptions<A extends APIParams, O extends BridgeAPIOptions<A>, P = any> extends BaseOptions<A, O, P> {
    initial?: boolean;
}
export interface BridgeResolver<A extends APIParams, O extends BridgeAPIOptions<A>, N extends keyof A> {
    initial: boolean;
    promise: Promise<ApiNList<A, O, N>>;
    resolve: (apiNList: ApiNList<A, O, N>) => void;
}
export type ApiNList<A extends APIParams, O extends BridgeAPIOptions<A>, N extends keyof A> = ConditionByIsMulti<O, N, RefObject<A[N]>[], RefObject<A[N]>>;