391 lines
16 KiB
TypeScript
391 lines
16 KiB
TypeScript
import { Aspect, EntityDict, CheckerType, AggregationResult } from "oak-domain/lib/types";
|
|
import { EntityDict as BaseEntityDict } from 'oak-domain/lib/base-app-domain';
|
|
import { CommonAspectDict } from 'oak-common-aspect';
|
|
import { Feature } from './Feature';
|
|
import { Pagination } from "./Pagination";
|
|
import { BasicFeatures } from "../features";
|
|
import { NamedFilterItem, NamedSorterItem } from './NamedCondition';
|
|
import { NotificationProps } from './Notification';
|
|
import { MessageProps } from './Message';
|
|
import { AsyncContext } from "oak-domain/lib/store/AsyncRowStore";
|
|
import { SyncContext } from "oak-domain/lib/store/SyncRowStore";
|
|
|
|
|
|
interface ComponentOption<
|
|
ED extends EntityDict & BaseEntityDict,
|
|
T extends keyof ED,
|
|
Cxt extends AsyncContext<ED>,
|
|
FrontCxt extends SyncContext<ED>,
|
|
AD extends Record<string, Aspect<ED, Cxt>>,
|
|
FD extends Record<string, Feature>,
|
|
FormedData extends Record<string, any>,
|
|
IsList extends boolean,
|
|
TProperty extends WechatMiniprogram.Component.PropertyOption = {},
|
|
> {
|
|
entity?: T | (() => T);
|
|
path?: string;
|
|
isList: IsList;
|
|
projection?: ED[T]['Selection']['data'] | ((options: {
|
|
features: BasicFeatures<ED, Cxt, FrontCxt, AD & CommonAspectDict<ED, Cxt>> & FD;
|
|
props: Partial<WechatMiniprogram.Component.PropertyOptionToData<TProperty>>;
|
|
state: Record<string, any>;
|
|
}) => ED[T]['Selection']['data']);
|
|
append?: boolean;
|
|
pagination?: Pagination;
|
|
filters?: Array<{
|
|
filter: ED[T]['Selection']['filter'] | ((options: {
|
|
features: BasicFeatures<ED, Cxt, FrontCxt, AD & CommonAspectDict<ED, Cxt>> & FD;
|
|
props: Partial<WechatMiniprogram.Component.PropertyOptionToData<TProperty>>;
|
|
state: Record<string, any>;
|
|
}) => ED[T]['Selection']['filter'] | undefined)
|
|
'#name'?: string;
|
|
}>;
|
|
sorters?: Array<{
|
|
sorter: NonNullable<ED[T]['Selection']['sorter']>[number] | ((options: {
|
|
features: BasicFeatures<ED, Cxt, FrontCxt, AD & CommonAspectDict<ED, Cxt>> & FD;
|
|
props: Partial<WechatMiniprogram.Component.PropertyOptionToData<TProperty>>;
|
|
state: Record<string, any>;
|
|
}) => NonNullable<ED[T]['Selection']['sorter']>[number])
|
|
'#name'?: string;
|
|
}>;
|
|
formData?: (options: {
|
|
data: IsList extends true ? Partial<ED[T]['Schema']>[] : Partial<ED[T]['Schema']> | undefined;
|
|
features: BasicFeatures<ED, Cxt, FrontCxt, AD & CommonAspectDict<ED, Cxt>> & FD;
|
|
props: Partial<WechatMiniprogram.Component.PropertyOptionToData<TProperty>>;
|
|
legalActions: ED[T]['Action'][];
|
|
}) => FormedData;
|
|
ns?: T | T[];
|
|
};
|
|
|
|
export type MiniprogramStyleMethods = {
|
|
animate(
|
|
selector: string,
|
|
keyFrames: WechatMiniprogram.Component.KeyFrame[],
|
|
duration: number,
|
|
callback?: () => void
|
|
): void
|
|
clearAnimation(
|
|
selector: string,
|
|
options?: WechatMiniprogram.Component.ClearAnimationOptions,
|
|
callback?: () => void
|
|
): void;
|
|
triggerEvent: <DetailType = any>(
|
|
name: string,
|
|
detail?: DetailType,
|
|
options?: WechatMiniprogram.Component.TriggerEventOption
|
|
) => void;
|
|
}
|
|
|
|
export type ComponentProps<IsList extends boolean, TProperty extends WechatMiniprogram.Component.PropertyOption> = IsList extends true ?
|
|
WechatMiniprogram.Component.PropertyOptionToData<OakListComponentProperties & OakComponentProperties & TProperty> :
|
|
WechatMiniprogram.Component.PropertyOptionToData<OakComponentProperties & TProperty>;
|
|
|
|
export type ComponentData<
|
|
ED extends EntityDict & BaseEntityDict,
|
|
T extends keyof ED,
|
|
FormedData extends WechatMiniprogram.Component.DataOption,
|
|
TData extends WechatMiniprogram.Component.DataOption
|
|
> = TData & FormedData & OakComponentData<ED, T>;
|
|
|
|
export type ComponentPublicThisType<
|
|
ED extends EntityDict & BaseEntityDict,
|
|
T extends keyof ED,
|
|
Cxt extends AsyncContext<ED>,
|
|
FrontCxt extends SyncContext<ED>,
|
|
AD extends Record<string, Aspect<ED, Cxt>>,
|
|
FD extends Record<string, Feature>,
|
|
FormedData extends Record<string, any>,
|
|
IsList extends boolean,
|
|
TData extends Record<string, any> = {},
|
|
TProperty extends WechatMiniprogram.Component.PropertyOption = {},
|
|
TMethod extends WechatMiniprogram.Component.MethodOption = {}
|
|
> = {
|
|
subscribed: Array<() => void>;
|
|
features: FD & BasicFeatures<ED, Cxt, FrontCxt, AD & CommonAspectDict<ED, Cxt>>;
|
|
state: ComponentData<ED, T, FormedData, TData>;
|
|
props: ComponentProps<IsList, TProperty>;
|
|
setState: (
|
|
data: Partial<ComponentData<ED, T, FormedData, TData>>,
|
|
callback?: () => void,
|
|
) => void;
|
|
triggerEvent: <DetailType = any>(
|
|
name: string,
|
|
detail?: DetailType,
|
|
options?: WechatMiniprogram.Component.TriggerEventOption
|
|
) => void;
|
|
} & TMethod & OakCommonComponentMethods<ED, T> & OakListComponentMethods<ED, T> & OakSingleComponentMethods<ED, T>;
|
|
|
|
export type ComponentFullThisType<
|
|
ED extends EntityDict & BaseEntityDict,
|
|
T extends keyof ED,
|
|
IsList extends boolean,
|
|
Cxt extends AsyncContext<ED>,
|
|
FrontCxt extends SyncContext<ED>
|
|
> = {
|
|
subscribed: Array<() => void>;
|
|
features: BasicFeatures<ED, Cxt, FrontCxt, CommonAspectDict<ED, Cxt>>;
|
|
state: OakComponentData<ED, T>;
|
|
props: ComponentProps<true, {}>;
|
|
setState: (
|
|
data: Partial<OakComponentData<ED, T>>,
|
|
callback?: () => void,
|
|
) => void;
|
|
triggerEvent: <DetailType = any>(
|
|
name: string,
|
|
detail?: DetailType,
|
|
options?: WechatMiniprogram.Component.TriggerEventOption
|
|
) => void;
|
|
} & OakCommonComponentMethods<ED, T> & OakListComponentMethods<ED, T> & OakSingleComponentMethods<ED, T>;
|
|
|
|
export type OakComponentOption<
|
|
ED extends EntityDict & BaseEntityDict,
|
|
T extends keyof ED,
|
|
Cxt extends AsyncContext<ED>,
|
|
FrontCxt extends SyncContext<ED>,
|
|
AD extends Record<string, Aspect<ED, Cxt>>,
|
|
FD extends Record<string, Feature>,
|
|
FormedData extends Record<string, any>,
|
|
IsList extends boolean,
|
|
TData extends Record<string, any>,
|
|
TProperty extends WechatMiniprogram.Component.PropertyOption,
|
|
TMethod extends Record<string, Function>,
|
|
> = ComponentOption<ED, T, Cxt, FrontCxt, AD, FD, FormedData, IsList, TProperty> &
|
|
Partial<{
|
|
data?: ((option: { features: BasicFeatures<ED, Cxt, FrontCxt, AD & CommonAspectDict<ED, Cxt>> & FD, props: ComponentProps<IsList, TProperty> }) => TData) | TData;
|
|
properties: Record<string, FunctionConstructor | WechatMiniprogram.Component.AllProperty>;
|
|
methods: TMethod;
|
|
lifetimes: {
|
|
created?(): void;
|
|
attached?(): void;
|
|
ready?(): void;
|
|
moved?(): void;
|
|
detached?(): void;
|
|
error?(err: Error): void;
|
|
show?(): void;
|
|
hide?(): void;
|
|
};
|
|
actions?: ED[T]['Action'][] | ((this: ComponentPublicThisType<
|
|
ED, T, Cxt, FrontCxt, AD, FD, FormedData, IsList, TData, TProperty, TMethod
|
|
>) => ED[T]['Action'][]);
|
|
observers: Record<string, (...args: any[]) => any>;
|
|
}> &
|
|
Partial<{
|
|
wechatMp: {
|
|
externalClasses?: string[];
|
|
options?: Partial<WechatMiniprogram.Component.ComponentOptions> | undefined;
|
|
}
|
|
}> & ThisType<ComponentPublicThisType<ED, T, Cxt, FrontCxt, AD, FD, FormedData, IsList, TData, TProperty, TMethod>>;
|
|
|
|
|
|
|
|
export type OakComponentProperties = {
|
|
oakPath: StringConstructor;
|
|
oakId: StringConstructor;
|
|
oakProjection: ObjectConstructor;
|
|
oakFrom: StringConstructor;
|
|
oakParentEntity: StringConstructor;
|
|
oakDisablePulldownRefresh: BooleanConstructor;
|
|
oakAutoUnmount: BooleanConstructor;
|
|
oakActions: ArrayConstructor;
|
|
};
|
|
|
|
export type OakListComponentProperties = {
|
|
oakFilters: ObjectConstructor;
|
|
oakSorters: ObjectConstructor;
|
|
oakIsPicker: BooleanConstructor;
|
|
oakPagination: ObjectConstructor;
|
|
}
|
|
|
|
export type OakNavigateToParameters<ED extends EntityDict & BaseEntityDict, T extends keyof ED> = {
|
|
oakId?: string;
|
|
oakEntity?: T;
|
|
oakPath?: string;
|
|
oakParent?: string;
|
|
oakProjection?: ED[T]['Selection']['data'],
|
|
oakSorters?: Array<NamedSorterItem<ED, T>>,
|
|
oakFilters?: Array<NamedFilterItem<ED, T>>;
|
|
oakIsPicker?: boolean;
|
|
[k: string]: any;
|
|
};
|
|
|
|
export type OakCommonComponentMethods<
|
|
ED extends EntityDict & BaseEntityDict,
|
|
T extends keyof ED
|
|
> = {
|
|
setDisablePulldownRefresh: (able: boolean) => void;
|
|
sub: (type: string, callback: Function) => void;
|
|
unsub: (type: string, callback: Function) => void;
|
|
pub: (type: string, options?: any) => void;
|
|
unsubAll: (type: string) => void;
|
|
save: (key: string, item: any) => void;
|
|
load: (key: string) => any;
|
|
clear: () => void;
|
|
resolveInput: <K extends string>(
|
|
input: any,
|
|
keys?: K[]
|
|
) => { dataset?: Record<string, any>; value?: string } & {
|
|
[k in K]?: any;
|
|
};
|
|
setNotification: (data: NotificationProps) => void;
|
|
consumeNotification: () => NotificationProps | undefined;
|
|
setMessage: (data: MessageProps) => void;
|
|
consumeMessage: () => MessageProps | undefined;
|
|
reRender: (extra?: Record<string, any>) => void;
|
|
getFreshValue: (path?: string) =>
|
|
| Partial<ED[keyof ED]['Schema']>[]
|
|
| Partial<ED[keyof ED]['Schema']>
|
|
| undefined;
|
|
navigateTo: <T2 extends keyof ED>(
|
|
options: { url: string } & OakNavigateToParameters<ED, T2>,
|
|
state?: Record<string, any>,
|
|
disableNamespace?: boolean
|
|
) => Promise<void>;
|
|
navigateBack: (delta?: number) => Promise<void>;
|
|
redirectTo: <T2 extends keyof ED>(
|
|
options: Parameters<typeof wx.redirectTo>[0] &
|
|
OakNavigateToParameters<ED, T2>,
|
|
state?: Record<string, any>,
|
|
disableNamespace?: boolean
|
|
) => Promise<void>;
|
|
// setProps: (props: Record<string, any>, usingState?: true) => void;
|
|
clean: (path?: string) => void;
|
|
|
|
t(key: string, params?: object): string;
|
|
execute: (action?: ED[T]['Action'], messageProps?: boolean | MessageProps) => Promise<void>;
|
|
checkOperation: (
|
|
ntity: T,
|
|
action: ED[T]['Action'],
|
|
filter?: ED[T]['Update']['filter'],
|
|
checkerTypes?: CheckerType[]
|
|
) => boolean;
|
|
tryExecute: (path?: string) => boolean | Error;
|
|
getOperations: (
|
|
path?: string
|
|
) => { operation: ED[T]['Operation']; entity: T }[] | undefined;
|
|
refresh: () => Promise<void>;
|
|
aggregate: (aggregation: ED[T]['Aggregation']) => Promise<AggregationResult<ED[T]['Schema']>>;
|
|
};
|
|
|
|
export type OakSingleComponentMethods<ED extends EntityDict & BaseEntityDict, T extends keyof ED> = {
|
|
setId: (id: string) => void;
|
|
unsetId: () => void;
|
|
getId: () => string | undefined;
|
|
// create: (data: Omit<ED[T]['CreateSingle']['data'], 'id'>, beforeExecute?: () => Promise<void>, afterExecute?: () => Promise<void>) => void;
|
|
update: (data: ED[T]['Update']['data'], action?: ED[T]['Action'], beforeExecute?: () => Promise<void>, afterExecute?: () => Promise<void>, path?: string) => void;
|
|
remove: (beforeExecute?: () => Promise<void>, afterExecute?: () => Promise<void>, path?: string) => void;
|
|
}
|
|
|
|
export type OakListComponentMethods<ED extends EntityDict & BaseEntityDict, T extends keyof ED> = {
|
|
loadMore: () => Promise<void>;
|
|
setFilters: (filters: NamedFilterItem<ED, T>[], path?: string) => void;
|
|
getFilters: (path?: string) => ED[T]['Selection']['filter'][] | undefined;
|
|
getFilterByName: (name: string, path?: string) => ED[T]['Selection']['filter'] | undefined;
|
|
addNamedFilter: (filter: NamedFilterItem<ED, T>, refresh?: boolean, path?: string) => void;
|
|
removeNamedFilter: (filter: NamedFilterItem<ED, T>, refresh?: boolean, path?: string) => void;
|
|
removeNamedFilterByName: (name: string, refresh?: boolean, path?: string) => void;
|
|
setNamedSorters: (sorters: NamedSorterItem<ED, T>[], path?: string) => void;
|
|
getSorters: (path?: string) => ED[T]['Selection']['sorter'] | undefined;
|
|
getSorterByName: (name: string, path?: string) => NonNullable<ED[T]['Selection']['sorter']>[number] | undefined;
|
|
addNamedSorter: (filter: NamedSorterItem<ED, T>, refresh?: boolean, path?: string) => void;
|
|
removeNamedSorter: (filter: NamedSorterItem<ED, T>, refresh?: boolean, path?: string) => void;
|
|
removeNamedSorterByName: (name: string, refresh?: boolean, path?: string) => void;
|
|
getPagination: (path?: string) => Pagination | undefined;
|
|
setPageSize: (pageSize: number, path?: string) => void;
|
|
setCurrentPage: (current: number, path?: string) => void;
|
|
|
|
addItem: (data: Omit<ED[T]['CreateSingle']['data'], 'id'>, beforeExecute?: () => Promise<void>, afterExecute?: () => Promise<void>, path?: string) => void;
|
|
removeItem: (id: string, beforeExecute?: () => Promise<void>, afterExecute?: () => Promise<void>, path?: string) => void;
|
|
updateItem: (data: ED[T]['Update']['data'], id: string, action?: ED[T]['Action'], beforeExecute?: () => Promise<void>, afterExecute?: () => Promise<void>, path?: string) => void;
|
|
recoverItem: (id: string, path?: string) => void;
|
|
};
|
|
|
|
type ComponentOnPropsChangeOption = {
|
|
path?: string;
|
|
parent?: string;
|
|
}
|
|
|
|
export type OakComponentOnlyMethods = {
|
|
onPropsChanged: (options: ComponentOnPropsChangeOption) => void;
|
|
registerReRender: () => void;
|
|
setOakActions: () => void;
|
|
};
|
|
|
|
export type OakComponentData<
|
|
ED extends EntityDict & BaseEntityDict,
|
|
T extends keyof ED
|
|
> = {
|
|
oakExecutable: boolean | Error;
|
|
oakExecuting: boolean;
|
|
oakFocused: {
|
|
attr: string;
|
|
message: string;
|
|
};
|
|
oakDirty: boolean;
|
|
oakLoading: boolean;
|
|
oakLoadingMore: boolean;
|
|
oakPullDownRefreshLoading: boolean;
|
|
oakEntity: T;
|
|
oakFullpath: string;
|
|
oakLegalActions?: ED[T]['Action'][];
|
|
oakDisablePulldownRefresh: boolean;
|
|
};
|
|
|
|
export type OakListComoponetData<
|
|
ED extends EntityDict & BaseEntityDict,
|
|
T extends keyof ED
|
|
> = {
|
|
oakFilters?: NonNullable<ED[T]['Selection']['filter']>[];
|
|
oakSorters?: NonNullable<ED[T]['Selection']['sorter']>[];
|
|
oakPagination?: Pagination;
|
|
}
|
|
|
|
export type MakeOakComponent<
|
|
ED extends EntityDict & BaseEntityDict,
|
|
Cxt extends AsyncContext<ED>,
|
|
FrontCxt extends SyncContext<ED>,
|
|
AD extends Record<string, Aspect<ED, Cxt>>,
|
|
FD extends Record<string, Feature>
|
|
> = <
|
|
T extends keyof ED,
|
|
FormedData extends WechatMiniprogram.Component.DataOption,
|
|
IsList extends boolean,
|
|
TData extends WechatMiniprogram.Component.DataOption,
|
|
TProperty extends WechatMiniprogram.Component.PropertyOption,
|
|
TMethod extends WechatMiniprogram.Component.MethodOption
|
|
>(
|
|
options: OakComponentOption<
|
|
ED,
|
|
T,
|
|
Cxt,
|
|
FrontCxt,
|
|
AD,
|
|
FD,
|
|
FormedData,
|
|
IsList,
|
|
TData,
|
|
TProperty,
|
|
TMethod
|
|
>
|
|
) => React.ComponentType<any>;
|
|
|
|
// 暴露给组件的方法
|
|
export type WebComponentCommonMethodNames = 'setNotification' | 'setMessage' | 'navigateTo' | 'navigateBack' | 'redirectTo' | 'clean' | 't' | 'execute' | 'refresh' | 'setDisablePulldownRefresh' | 'aggregate';
|
|
|
|
// 暴露给list组件的方法
|
|
export type WebComponentListMethodNames = 'loadMore' | 'setFilters' | 'addNamedFilter' | 'removeNamedFilter' | 'removeNamedFilterByName' | 'setNamedSorters'
|
|
| 'addNamedSorter' | 'removeNamedSorter' | 'removeNamedSorterByName' | 'setPageSize' | 'setCurrentPage' | 'addItem' | 'removeItem' | 'updateItem';
|
|
|
|
// 暴露给single组件的方法
|
|
export type WebComponentSingleMethodNames = 'update' | 'remove';
|
|
|
|
export type WebComponentProps<
|
|
ED extends EntityDict & BaseEntityDict,
|
|
T extends keyof ED,
|
|
IsList extends boolean,
|
|
TData extends WechatMiniprogram.Component.DataOption = {},
|
|
TMethod extends WechatMiniprogram.Component.MethodOption = {}> = {
|
|
methods: TMethod & OakCommonComponentMethods<ED, T>
|
|
& OakListComponentMethods<ED, T> & OakSingleComponentMethods<ED, T>;
|
|
data: TData & OakComponentData<ED, T> & (IsList extends true ? OakListComoponetData<ED, T> : {});
|
|
}
|