limu

export declare type AnyObject<T extends any = any> = { [key: string]: T; }; export declare type Fn = (...args: any[]) => any; export declare type Primitive = boolean | number | string | symbol | null | undefined | BigInt; export declare type AnyArray = Array<any>; export declare type NumStrSymbol = number | string | symbol; export declare type Key = string | symbol; export declare type ObjectLike = AnyObject | AnyArray | Map<any, any> | Set<any>; export declare type Op = 'del' | 'set' | 'get'; export declare type DataType = 'Map' | 'Set' | 'Array' | 'Object'; export interface IExecOnOptions { parentMeta: DraftMeta | null; value: any; isChanged?: boolean; isCustom?: boolean; mayProxyVal?: any; } export interface DraftMeta<T = AnyObject> { id: string; /** 数据源 id 标识，相同 sourceId 可能经历多次 finishDraft createDraft */ sourceId: string; rootMeta: DraftMeta; parentMeta: null | DraftMeta; parent: null | ObjectLike; parents: ObjectLike[]; selfType: DataType; self: T; copy: T; modified: boolean; /** 记录数组顺序是否发生变化，辅助数组结构的数据在 clearScopes 阶段决策如何重赋值 */ isArrOrderChanged: boolean; hasOnOperate: boolean; execOnOperate: (op: Op, key: string, options: IExecOnOptions) => any; isImmutBase: boolean; isDel: boolean; /** 记录某些key对应值是否是一个全新节点 */ newNodeStats: AnyObject<boolean>; key: string; /** 当前数据节点的访问路径数组，可能包含 symbol 值 */ keyPath: string[]; /** 此路径中会将 symbol 转为内部识别的 string 存储 */ keyStrPath: string[]; /** keyStrPath 数组转换后的 string */ keyStrPathStr: string; /** * 多条路径指向当前对象时，keyPaths.length > 1，子项列表里可能包含 Symbol 节点 * 形如：[ ['a', 'b', 'c'], ['a1', Symbol('1'), 'c1'] ] */ keyPaths: string[][]; /** * 多条指向当前对象的此路径，子项中会将 symbol 转为内部识别的 string 存储 * 形如：[ ['a', 'b', 'c'], ['a1', 'Symbol_1', 'c1'] ] */ keyStrPaths: string[][]; /** * 访问到当前节点的最近一个数组路径，如没有则为 [] * 如当前节点为 keyPath： ['a', 'list', '0', 'desc', 'age'] * 则 arrKeyPath 为：['a', 'list', '0'] */ arrKeyPath: string[]; /** 访问到当前节点的最近一个数组路径列表，如没有则为 []，服务于多引用 */ arrKeyPaths: string[][]; level: number; scopes: DraftMeta[]; proxyVal: T; proxyItems: null | Map<any, any> | Set<any>; /** scope version */ ver: string; /** * record the comparision rule of root proxy state */ compareVer: boolean; revoke: any; } export interface IOperateParams { /** 操作记录是否来自于 immut 创建的对象 */ immutBase: boolean; /** 如果时根节点，父亲为 undefined */ parent?: any; /** 如果时根节点，父亲代理为 undefined */ parentProxy?: any; /** 父亲节点的类型，零长字符串表示无父亲节点 */ parentType: DataType | ''; /** key 可能为 symbol，请谨慎处理 */ key: any; /** * key path contains parent node key */ keyPath: string[]; /** * key path contains current node key */ fullKeyPath: string[]; /** * 多条路径指向当前对象时，keyPaths.length > 1 */ keyPaths: string[][]; /** * 多条执行当前对象的此路径，子项中会将 symbol 转为内部识别的 string 存储 */ keyStrPaths: string[][]; /** * 访问到当前节点的最近的一个数组路径（注：只到数组下标为止），如没有则为 [] */ arrKeyPath: string[]; /** * 访问到当前节点的最近一个数组路径列表，如没有则为 []，服务于多引用 */ arrKeyPaths: string[][]; /** * is key comes from built-in fn */ isBuiltInFnKey: boolean; /** * is data node changed by current operation */ isChanged: boolean; /** * is key come from customKeys or not */ isCustom: boolean; op: Op; /** raw value */ value: any; /** proxy value */ proxyValue: any; /** * when get op triggered, user can pass a new value to replace the inner returned value, * when set op triggered, user can pass a new value to replace the previous setted value, * this is a dangerous behavior, the caller should be responsible for the consequence */ replaceValue: (newValue: any) => void; /** * get replaced info */ getReplaced: <T = any>() => { isReplaced: boolean; replacedValue: T; }; } export interface ICreateDraftOptions { /** * default: true, * autoRevoke = true means that all draft proxy node will be revoke by limu internal code after finishDraft. */ autoRevoke?: boolean; /** * default: true, * when autoRevoke = false, changing a proxy draft node will cause an error: * TypeError: 'set' on proxy: trap returned falsish for property '{xxx_prop_name}', * limu will silence this error by default, but if user want to catch this error, * user can set silenceSetTrapErr=false. */ silenceSetTrapErr?: boolean; /** * default: global.autoFreeze ( false ), * allow user overwrite global autoFreeze setting in current call process */ autoFreeze?: boolean; /** * any draft operation will trigger this callback */ onOperate?: (params: IOperateParams) => any; /** * create a read only draft */ readOnly?: boolean; /** * default: false, set the comparision rule of root proxy state, * the below code explains the function of this parameter * ```ts * const base = {...}; * // when compareVer = false, below result will be true * isDiff(immut(base), immut(base)); * * // when compareVer = true, below result will be false * isDiff(immut(base), immut(base)); * ``` * also applicable to `createDraft(base, {readOnly:true})` */ compareVer?: boolean; /** * defaut: false, there will be no warn tip in the console for changing immut object while set disableWarn true */ disableWarn?: boolean; customKeys?: NumStrSymbol[]; /** * default: false，（v4.1 新增） * 关闭代理行为，设置为 true 时，不再生成代理，总是返回原始对象 * @example * const draft = createDraft(base); * draft === base; // true * const final = finishDraft(draft); * final === draft; // true * final === base; // true */ disableProxy?: boolean; /** * 数据源 id，不透传的话内部会自己生成一个，用于表示多个版本的草稿数据来源于同一份初始数据 */ sourceId?: string; } export declare type IImutOptions = Omit<ICreateDraftOptions, 'readOnly'>; export interface IInnerCreateDraftOptions extends ICreateDraftOptions { [key: symbol]: any; } export interface IApiCtx { metaMap: Map<any, DraftMeta>; /** rootMeta 用此属性记录所有新节点 */ newNodeMap: Map<any, { parent: any; key: any; node: any; target: any; }>; metaVer: string; } /** key: metaVer, value, apiCtx */ export declare type RootCtx = Map<string, IApiCtx>;