273 lines
18 KiB
TypeScript
273 lines
18 KiB
TypeScript
/// <reference types="wechat-miniprogram" />
|
||
/// <reference types="wechat-miniprogram" />
|
||
import { Aspect, EntityDict, CheckerType, AggregationResult, OpRecord, OakUserException } from "oak-domain/lib/types";
|
||
import { EntityDict as BaseEntityDict } from 'oak-domain/lib/base-app-domain';
|
||
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";
|
||
import React from "react";
|
||
export type DataOption = WechatMiniprogram.Component.DataOption;
|
||
export type MethodOption = WechatMiniprogram.Component.MethodOption;
|
||
/**
|
||
* 微信的原声明中少写了FunctionConstructor，只能抄一遍
|
||
*/
|
||
export type ActionDef<ED extends EntityDict & BaseEntityDict, T extends keyof ED> = {
|
||
action: ED[T]['Action'];
|
||
filter?: ED[T]['Selection']['filter'];
|
||
data?: Partial<ED[T]['CreateSingle']['data']>;
|
||
label?: string;
|
||
attrs?: (keyof ED[T]['Update']['data'] | '#all')[];
|
||
} | ED[T]['Action'];
|
||
export type RowWithActions<ED extends EntityDict & BaseEntityDict, T extends keyof ED> = Partial<ED[T]['Schema']> & {
|
||
'#oakLegalActions': ActionDef<ED, T>[];
|
||
'#oakLegalCascadeActions': {
|
||
[K in keyof ED[T]['Schema']]?: ActionDef<ED, keyof ED>[];
|
||
};
|
||
};
|
||
type FeatureDef<IsList extends boolean, 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>, TData extends DataOption, TProperty extends DataOption, TMethod extends Record<string, Function>, EMethod extends Record<string, Function> = {}> = (keyof (FD & BasicFeatures<ED>)) | {
|
||
feature: keyof (FD & BasicFeatures<ED>);
|
||
behavior?: 'reRender' | 'refresh';
|
||
callback?: (this: ComponentPublicThisType<ED, T, Cxt, FrontCxt, AD, FD, FormedData, IsList, TData, TProperty, TMethod, EMethod>) => void;
|
||
};
|
||
type DevideWidth = 'pc' | 'mobile';
|
||
interface ComponentOption<IsList extends boolean, 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>, TData extends DataOption, TProperty extends DataOption, TMethod extends Record<string, Function>, EMethod extends Record<string, Function> = {}> {
|
||
isList?: IsList;
|
||
singleton?: true;
|
||
getTotal?: {
|
||
max: number;
|
||
deviceWidth?: DevideWidth | 'all';
|
||
} | number;
|
||
entity?: T | ((this: ComponentPublicThisType<ED, T, Cxt, FrontCxt, AD, FD, FormedData, IsList, TData, TProperty, TMethod, EMethod>) => T);
|
||
path?: string;
|
||
features?: FeatureDef<IsList, ED, T, Cxt, FrontCxt, AD, FD, FormedData, TData, TProperty, TMethod, EMethod>[];
|
||
cascadeActions?: (this: ComponentPublicThisType<ED, T, Cxt, FrontCxt, AD, FD, FormedData, IsList, TData, TProperty, TMethod, EMethod>) => {
|
||
[K in keyof ED[T]['Schema']]?: ActionDef<ED, keyof ED>[];
|
||
};
|
||
actions?: ActionDef<ED, T>[] | ((this: ComponentPublicThisType<ED, T, Cxt, FrontCxt, AD, FD, FormedData, IsList, TData, TProperty, TMethod, EMethod>) => ActionDef<ED, T>[]);
|
||
projection?: ED[T]['Selection']['data'] | ((this: ComponentPublicThisType<ED, T, Cxt, FrontCxt, AD, FD, FormedData, IsList, TData, TProperty, TMethod, EMethod>) => ED[T]['Selection']['data'] | undefined);
|
||
append?: boolean;
|
||
pagination?: Pick<Pagination, 'currentPage' | 'pageSize' | 'randomRange'> | Array<Pick<Pagination, 'currentPage' | 'pageSize' | 'randomRange'> & {
|
||
deviceWidth: DevideWidth;
|
||
}>;
|
||
filters?: Array<{
|
||
filter: NonNullable<ED[T]['Selection']['filter']> | ((this: ComponentPublicThisType<ED, T, Cxt, FrontCxt, AD, FD, FormedData, IsList, TData, TProperty, TMethod, EMethod>) => ED[T]['Selection']['filter'] | undefined);
|
||
'#name'?: string;
|
||
}>;
|
||
sorters?: Array<{
|
||
sorter: NonNullable<ED[T]['Selection']['sorter']>[number] | ((this: ComponentPublicThisType<ED, T, Cxt, FrontCxt, AD, FD, FormedData, IsList, TData, TProperty, TMethod, EMethod>) => ED[T]['Selection']['sorter'] | NonNullable<ED[T]['Selection']['sorter']>[number]);
|
||
'#name'?: string;
|
||
}>;
|
||
formData?: (options: {
|
||
data: IsList extends true ? RowWithActions<ED, T>[] : RowWithActions<ED, T>;
|
||
origin?: IsList extends true ? RowWithActions<ED, T>[] : RowWithActions<ED, T>;
|
||
features: BasicFeatures<ED> & FD;
|
||
props: TProperty;
|
||
legalActions?: ActionDef<ED, T>[];
|
||
originLegalActions?: ActionDef<ED, T>[];
|
||
dirty: boolean;
|
||
modified: boolean;
|
||
}) => FormedData;
|
||
ns?: T | T[];
|
||
data?: ((this: ComponentPublicThisType<ED, T, Cxt, FrontCxt, AD, FD, FormedData, IsList, TData, TProperty, TMethod, EMethod>) => TData) | TData;
|
||
properties?: TProperty;
|
||
methods?: TMethod;
|
||
}
|
||
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<ED extends EntityDict & BaseEntityDict, T extends keyof ED, TProperty extends DataOption> = OakComponentProperties<ED, T> & Partial<TProperty>;
|
||
export type ReactComponentProps<ED extends EntityDict & BaseEntityDict, T extends keyof ED, IsList extends boolean, TProperty extends DataOption> = ComponentProps<ED, T, TProperty> & {
|
||
className?: string;
|
||
style?: Record<string, any>;
|
||
};
|
||
export type ComponentData<ED extends EntityDict & BaseEntityDict, T extends keyof ED, FormedData extends DataOption, TData extends 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 DataOption = {}, TMethod extends MethodOption = {}, EMethod extends Record<string, Function> = {}> = {
|
||
features: FD & BasicFeatures<ED>;
|
||
state: ComponentData<ED, T, FormedData, TData>;
|
||
props: Readonly<ComponentProps<ED, T, 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 & EMethod & OakCommonComponentMethods<ED, T> & OakListComponentMethods<ED, T> & OakSingleComponentMethods<ED, T>;
|
||
export type OakLifetime = 'born' | 'created' | 'attached' | 'ready' | 'detached';
|
||
export type ComponentFullThisType<ED extends EntityDict & BaseEntityDict, T extends keyof ED> = {
|
||
features: BasicFeatures<ED>;
|
||
state: OakComponentData<ED, T>;
|
||
props: ComponentProps<ED, T, {}>;
|
||
setState: (data: Partial<OakComponentData<ED, T>>, callback?: () => void) => void;
|
||
triggerEvent: <DetailType = any>(name: string, detail?: DetailType, options?: WechatMiniprogram.Component.TriggerEventOption) => void;
|
||
oakLifetime: OakLifetime;
|
||
} & OakCommonComponentMethods<ED, T> & OakListComponentMethods<ED, T> & OakSingleComponentMethods<ED, T>;
|
||
export type OakComponentOption<IsList extends boolean, ED extends EntityDict & BaseEntityDict, T extends keyof ED, Cxt extends AsyncContext<ED>, FrontCxt extends SyncContext<ED>, AD extends Record<string, Aspect<ED, AsyncContext<ED>>>, FD extends Record<string, Feature>, FormedData extends Record<string, any>, TData extends Record<string, any>, TProperty extends DataOption, TMethod extends Record<string, Function>, EMethod extends Record<string, Function> = {}> = ComponentOption<IsList, ED, T, Cxt, FrontCxt, AD, FD, FormedData, TData, TProperty, TMethod, EMethod> & Partial<{
|
||
lifetimes: {
|
||
created?(): void;
|
||
attached?(): void;
|
||
ready?(): any;
|
||
moved?(): void;
|
||
detached?(): void;
|
||
error?(err: Error): void;
|
||
show?(): void;
|
||
hide?(): void;
|
||
resize?(size: WechatMiniprogram.Page.IResizeOption): void;
|
||
};
|
||
listeners: Record<string, (this: ComponentPublicThisType<ED, T, Cxt, FrontCxt, AD, FD, FormedData, IsList, TData, TProperty, TMethod, EMethod>, prev: Record<string, any>, next: Record<string, any>) => void>;
|
||
}> & Partial<{
|
||
wechatMp: {
|
||
externalClasses?: string[];
|
||
options?: Partial<WechatMiniprogram.Component.ComponentOptions> | undefined;
|
||
};
|
||
}> & ThisType<ComponentPublicThisType<ED, T, Cxt, FrontCxt, AD, FD, FormedData, IsList, TData, TProperty, TMethod, EMethod>>;
|
||
type OakComponentProperties<ED extends EntityDict & BaseEntityDict, T extends keyof ED> = Partial<{
|
||
width: 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl';
|
||
oakPath: string;
|
||
oakId: string;
|
||
oakFrom: string;
|
||
oakParentEntity: string;
|
||
oakDisablePulldownRefresh: boolean;
|
||
oakZombie: boolean;
|
||
oakAutoUnmount: boolean;
|
||
oakActions: string;
|
||
oakCascadeActions: string;
|
||
oakFilters: Array<ED[T]['Selection']['filter']>;
|
||
} & React.RefAttributes<HTMLElement>>;
|
||
export type OakListComponentProperties<ED extends EntityDict & BaseEntityDict, T extends keyof ED> = Partial<{}>;
|
||
export type OakNavigateToParameters<ED extends EntityDict & BaseEntityDict, T extends keyof ED> = {
|
||
oakId?: string;
|
||
oakPath?: string;
|
||
oakParent?: string;
|
||
[k: string]: any;
|
||
};
|
||
export type OakCommonComponentMethods<ED extends EntityDict & BaseEntityDict, T extends keyof ED> = {
|
||
addFeatureSub: (name: string, callback: (args?: any) => void) => void;
|
||
removeFeatureSub: (name: string, callback: (args?: any) => void) => void;
|
||
unsubscribeAll: () => void;
|
||
subscribeAll: () => void;
|
||
save: (key: string, item: any) => Promise<void>;
|
||
load: (key: string) => Promise<any>;
|
||
clear: (key?: string) => Promise<void>;
|
||
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>;
|
||
switchTab: <T2 extends keyof ED>(options: Parameters<typeof wx.switchTab>[0] & OakNavigateToParameters<ED, T2>, state?: Record<string, any>, disableNamespace?: boolean) => Promise<void>;
|
||
savePoint: () => number;
|
||
clean: (lsn?: number, dontPublish?: true, path?: string) => void;
|
||
isDirty: (path?: string) => boolean;
|
||
t(key: string, params?: object): string;
|
||
execute: (action?: ED[T]['Action'], messageProps?: boolean | MessageProps, path?: string, opers?: Array<{
|
||
entity: T;
|
||
operation: ED[T]['Operation'];
|
||
}>) => Promise<void>;
|
||
checkOperation: <T2 extends keyof ED>(entity: T2, operation: {
|
||
action: ED[T2]['Action'];
|
||
data?: ED[T2]['Operation']['data'];
|
||
filter?: ED[T2]['Operation']['filter'];
|
||
}, checkerTypes?: (CheckerType | 'relation')[]) => boolean | OakUserException<ED>;
|
||
tryExecute: (path?: string, action?: ED[T]['Action']) => boolean | OakUserException<ED>;
|
||
getOperations: (path?: string) => {
|
||
operation: ED[T]['Operation'];
|
||
entity: T;
|
||
}[] | undefined;
|
||
refresh: () => Promise<void>;
|
||
aggregate: (aggregation: ED[T]['Aggregation']) => Promise<AggregationResult<ED[T]['Schema']>>;
|
||
subDataEvents: (events: string[], moduleName: string, callback?: (event: string, opRecords: OpRecord<ED>[]) => void) => Promise<void>;
|
||
unsubDataEvents: (events: string[], moduleName: string) => Promise<void>;
|
||
};
|
||
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'>, path?: string) => void;
|
||
update: (data: ED[T]['Update']['data'], action?: ED[T]['Action'], path?: string) => void;
|
||
remove: (path?: string) => void;
|
||
isCreation: (path?: string) => boolean;
|
||
};
|
||
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;
|
||
setNamedFilters: (filters: 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>[], refresh?: boolean, path?: string) => void;
|
||
getSorters: (path?: string) => ED[T]['Selection']['sorter'] | undefined;
|
||
getSorterByName: (name: string, path?: string) => NonNullable<ED[T]['Selection']['sorter']>[number] | undefined;
|
||
addNamedSorter: (sorter: NamedSorterItem<ED, T>, refresh?: boolean, path?: string) => void;
|
||
removeNamedSorter: (sorter: 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'> & {
|
||
id?: string;
|
||
}, path?: string) => string;
|
||
addItems: (data: Array<Omit<ED[T]['CreateSingle']['data'], 'id'> & {
|
||
id?: string;
|
||
}>, path?: string) => string[];
|
||
removeItem: (id: string, path?: string) => void;
|
||
removeItems: (ids: string[], path?: string) => void;
|
||
updateItem: (data: ED[T]['Update']['data'], id: string, action?: ED[T]['Action'], path?: string) => void;
|
||
updateItems: (data: ED[T]['Update']['data'], ids: string[], action?: ED[T]['Action'], path?: string) => void;
|
||
recoverItem: (id: string, path?: string) => void;
|
||
recoverItems: (ids: string[], path?: string) => void;
|
||
resetItem: (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;
|
||
};
|
||
oakModified: boolean;
|
||
oakDirty: boolean;
|
||
oakLoading: boolean;
|
||
oakLoadingMore: boolean;
|
||
oakPullDownRefreshLoading: boolean;
|
||
oakEntity: T;
|
||
oakFullpath: string;
|
||
oakLegalActions?: ED[T]['Action'][];
|
||
oakLocales: Record<string, any>;
|
||
oakLocalesVersion: number;
|
||
oakLng: string;
|
||
oakDefaultLng: string;
|
||
};
|
||
type OakListComoponetData<ED extends EntityDict & BaseEntityDict, T extends keyof ED> = {
|
||
oakPagination?: Pagination;
|
||
};
|
||
export type MakeOakComponent<ED extends EntityDict & BaseEntityDict, Cxt extends AsyncContext<ED>, FrontCxt extends SyncContext<ED>, AD extends Record<string, Aspect<ED, AsyncContext<ED>>>, FD extends Record<string, Feature>> = <IsList extends boolean, T extends keyof ED, FormedData extends DataOption, TData extends DataOption, TProperty extends DataOption, TMethod extends MethodOption>(options: OakComponentOption<IsList, ED, T, Cxt, FrontCxt, AD, FD, FormedData, TData, TProperty, TMethod>) => (props: ReactComponentProps<ED, T, IsList, TProperty>) => React.ReactElement;
|
||
export type WebComponentCommonMethodNames = 'setNotification' | 'setMessage' | 'navigateTo' | 'navigateBack' | 'redirectTo' | 'clean' | 't' | 'execute' | 'refresh' | 'aggregate' | 'checkOperation' | 'isDirty';
|
||
export type WebComponentListMethodNames = 'loadMore' | 'setFilters' | 'addNamedFilter' | 'removeNamedFilter' | 'removeNamedFilterByName' | 'setNamedSorters' | 'addNamedSorter' | 'removeNamedSorter' | 'removeNamedSorterByName' | 'setPageSize' | 'setCurrentPage' | 'addItem' | 'addItems' | 'removeItem' | 'removeItems' | 'updateItem' | 'updateItems' | 'resetItem' | 'recoverItem' | 'recoverItems';
|
||
export type WebComponentSingleMethodNames = 'update' | 'remove' | 'create' | 'isCreation' | 'getId' | 'setId';
|
||
export type WebComponentProps<ED extends EntityDict & BaseEntityDict, T extends keyof ED, IsList extends boolean, TData extends DataOption = {}, TMethod extends MethodOption = {}> = {
|
||
methods: TMethod & OakCommonComponentMethods<ED, T> & OakListComponentMethods<ED, T> & OakSingleComponentMethods<ED, T>;
|
||
data: TData & OakComponentData<ED, T> & (IsList extends true ? OakListComoponetData<ED, T> : {
|
||
oakId?: string;
|
||
});
|
||
};
|
||
export {};
|