@flowlist/js-core 3.0.10 → 3.0.11

package/dist/index.d.ts

@@ -3,183 +3,205 @@
  */
 type ObjectKey = string | number;
 /**
- * 通用键值对映射（注意：尽管 ObjectKey 包含 number，
- * 但在实际对象中，number 键会被转为 string。
- * 此处使用 string 以符合 Record 的实际行为 [[3]]）
+ * 通用键值对映射 - 使用 Record 以保持灵活性和性能
  */
 type KeyMap = Record<string, unknown>;
 /**
- * 形态数组
+ * 数组元素类型
  */
-type ResultType = KeyMap | unknown[];
+type ResultArrayType = KeyMap[];
 /**
- * 数据源类型：可以是 API 路径字符串，或返回 Promise 的函数
+ * 对象结果类型：键为字符串，值为 KeyMap 数组
  */
-type DataSource = string | ((params: unknown) => Promise<unknown>);
+type ResultObjectType = Record<string, KeyMap[]>;
 /**
- * 字段获取器：根据字段名获取状态对象
+ * 结果类型：可以是数组或对象
  */
-type FieldGetter = (key: string) => DefaultField | undefined;
+type ResultType = ResultArrayType | ResultObjectType;
 /**
- * 状态设置器函数类型
+ * API 函数类型
  */
-type FieldSetter = (obj: SetterFuncParams) => void;
+type ApiFunction = (_params: KeyMap) => Promise<ApiResponse>;
 /**
- * 获取数据后的回调函数
+ * 数据源类型：可以是 API 路径字符串，或返回 Promise 的函数
  */
-type FetchResultCallback = (obj: {
-    params: GenerateParamsResp;
-    data: ApiResponse;
-    refresh: boolean;
-}) => void;
+type DataSource = string | ApiFunction;
+interface DefaultField {
+    result: ResultType;
+    noMore: boolean;
+    nothing: boolean;
+    loading: boolean;
+    error: Error | null;
+    extra: KeyMap | null;
+    fetched: boolean;
+    page: number;
+    total: number;
+}
+type FieldKeys = keyof DefaultField;
 /**
- * 数据获取类型枚举
+ * 字段获取器：根据字段名获取状态对象
  */
-type FetchType = 'jump' | 'sinceId' | 'page' | 'seenIds' | 'auto';
+type FieldGetter = (_key: string) => DefaultField | undefined;
 /**
- * 字段数据的关键字
+ * Setter 函数的参数
  */
-type FieldKeys = 'result' | 'noMore' | 'nothing' | 'loading' | 'error' | 'extra' | 'fetched' | 'page' | 'total';
-interface CommonParams {
-    func: DataSource;
-    type: FetchType;
-    query?: KeyMap;
-    uniqueKey?: string;
-    callback?: FetchResultCallback;
+interface SetterFuncParams {
+    readonly key: string;
+    readonly type: number;
+    readonly value: Partial<DefaultField> | DefaultField;
+    readonly callback?: (_obj?: KeyMap) => void;
 }
 /**
- * 生成请求参数的输入
+ * 状态设置器函数类型
  */
-interface GenerateParamsType {
-    field: DefaultField;
-    uniqueKey?: string;
-    query?: KeyMap;
-    type: FetchType;
-}
+type FieldSetter = (_obj: SetterFuncParams) => void;
+/**
+ * 数据获取类型枚举
+ */
+type FetchType = 'jump' | 'sinceId' | 'page' | 'seenIds' | 'auto';
 /**
  * 生成请求参数的输出
  */
-interface GenerateParamsResp {
+interface GenerateParamsResp extends KeyMap {
     seen_ids?: string;
     since_id?: ObjectKey;
     is_up?: 0 | 1;
     page?: number;
 }
 /**
- * Setter 函数的参数
+ * 生成请求参数的输入
  */
-interface SetterFuncParams {
-    key: string;
-    type: number;
-    value: unknown;
-    callback?: (obj?: KeyMap) => void;
+interface GenerateParamsType {
+    readonly field: DefaultField;
+    readonly uniqueKey?: string;
+    readonly query?: KeyMap;
+    readonly type: FetchType;
 }
 /**
- * 默认字段数据结构，使用泛型 T 和 E 分别代表 result 和 extra 的类型
+ * API 响应结构
  */
-interface DefaultField {
-    result: ResultType;
-    noMore: boolean;
-    nothing: boolean;
-    loading: boolean;
-    error: null | Error;
-    extra: unknown;
-    fetched: boolean;
-    page: number;
-    total: number;
+interface ApiResponse {
+    readonly result: ResultType;
+    readonly extra?: KeyMap;
+    readonly total?: number;
+    readonly no_more?: boolean;
 }
 /**
- * API 响应结构，使用泛型 T 和 E
+ * 获取数据后的回调函数
  */
-interface ApiResponse {
-    result: ResultType;
-    extra?: unknown;
-    total?: number;
-    no_more?: boolean;
+type FetchResultCallback = (_obj: {
+    params: KeyMap;
+    data: ApiResponse;
+    refresh: boolean;
+}) => void;
+interface CommonParams {
+    readonly func: DataSource;
+    readonly type: FetchType;
+    readonly query?: KeyMap;
+    readonly uniqueKey?: string;
+    readonly callback?: FetchResultCallback;
 }
 interface BaseFetchConfig extends CommonParams {
-    getter: FieldGetter;
-    setter: FieldSetter;
-    api?: KeyMap;
+    readonly getter: FieldGetter;
+    readonly setter: FieldSetter;
+    readonly api?: Record<string, ApiFunction>;
+}
+/**
+ * 初始化状态的参数对外接口
+ */
+interface InitStateParams {
+    readonly func: DataSource;
+    readonly type: FetchType;
+    readonly query?: KeyMap;
+    readonly opts?: Partial<DefaultField>;
 }
 /**
- * 初始化状态的参数
+ * 初始化状态的参数（内部）
  */
 interface InitStateType extends InitStateParams {
-    getter: FieldGetter;
-    setter: FieldSetter;
+    readonly getter: FieldGetter;
+    readonly setter: FieldSetter;
 }
 /**
- * 初始化数据的参数
+ * 初始化数据的参数对外接口
+ */
+type InitDataParams = CommonParams;
+/**
+ * 初始化数据的参数（内部）
  */
 type InitDataType = BaseFetchConfig;
 /**
- * 加载更多的参数
+ * 加载更多的参数对外接口
+ */
+interface LoadMoreParams extends CommonParams {
+    readonly errorRetry?: boolean;
+}
+/**
+ * 加载更多的参数（内部）
  */
 interface LoadMoreType extends BaseFetchConfig {
-    errorRetry?: boolean;
+    readonly errorRetry?: boolean;
+}
+/**
+ * 更新状态的参数（内部使用）
+ */
+interface UpdateStateType<T = KeyMap> {
+    readonly getter: FieldGetter;
+    readonly setter: FieldSetter;
+    readonly func: DataSource;
+    readonly type: FetchType;
+    readonly query?: KeyMap;
+    readonly method: string;
+    readonly value: T | ResultArrayType | ResultObjectType | KeyMap;
+    readonly id?: ObjectKey | ObjectKey[];
+    readonly changeKey?: string;
+    readonly uniqueKey?: string;
 }
 /**
- * 更新状态的参数
+ * 更新状态的参数（对外接口）
  */
-interface UpdateStateType {
-    getter: FieldGetter;
-    setter: FieldSetter;
-    func: DataSource;
-    type: FetchType;
-    query?: KeyMap;
-    method: string;
-    value: ResultArrayType$1 | Record<ObjectKey, KeyMap>;
-    id?: string | number | ObjectKey[];
-    changeKey?: string;
-    uniqueKey?: string;
+interface UpdateStateParams<T = KeyMap> {
+    readonly func: DataSource;
+    readonly type: FetchType;
+    readonly query?: KeyMap;
+    readonly method: string;
+    readonly value: T | ResultArrayType | ResultObjectType | KeyMap;
+    readonly id?: ObjectKey | ObjectKey[];
+    readonly changeKey?: string;
+    readonly uniqueKey?: string;
 }
 /**
  * 设置数据的参数
  */
 interface SetDataType {
-    getter: FieldGetter;
-    setter: FieldSetter;
-    data: ApiResponse;
-    fieldName: string;
-    type: FetchType;
-    page: number;
-    insertBefore: boolean;
+    readonly getter: FieldGetter;
+    readonly setter: FieldSetter;
+    readonly data: ApiResponse;
+    readonly fieldName: string;
+    readonly type: FetchType;
+    readonly page: number;
+    readonly insertBefore: boolean;
 }
 /**
  * 设置错误的参数
  */
 interface SetErrorType {
-    setter: FieldSetter;
-    fieldName: string;
-    error: null | Error;
-}
-type ResultArrayType$1 = KeyMap[];
-type ResultObjectType$1 = Record<ObjectKey, KeyMap[]>;
-type InitDataParams = CommonParams;
-interface LoadMoreParams extends CommonParams {
-    errorRetry?: boolean;
-}
-interface InitStateParams {
-    func: DataSource;
-    type: FetchType;
-    query?: KeyMap;
-    opts?: Partial<DefaultField>;
+    readonly setter: FieldSetter;
+    readonly fieldName: string;
+    readonly error: Error | null;
 }
 
 declare const initState: ({ getter, setter, func, type, query, opts }: InitStateType) => Promise<void>;
 declare const initData: ({ getter, setter, func, type, query, api, uniqueKey, callback }: InitDataType) => Promise<void>;
 declare const loadMore: ({ getter, setter, query, type, func, api, uniqueKey, errorRetry, callback }: LoadMoreType) => Promise<void>;
-declare const updateState: ({ getter, setter, func, type, query, method, value, id, uniqueKey, changeKey }: UpdateStateType) => Promise<unknown>;
+declare const updateState: <T = KeyMap>({ getter, setter, func, type, query, method, value, id, uniqueKey, changeKey }: UpdateStateType<T>) => Promise<unknown>;
 
 declare const isArray: (data: unknown) => data is unknown[];
 declare const isObjectResult: (data: unknown) => data is Record<string, unknown>;
 declare const generateDefaultField: (opts?: Partial<DefaultField>) => DefaultField;
 declare const generateFieldName: ({ func, type, query }: InitDataParams) => string;
-declare const getObjectDeepValue: (field: unknown, keys?: string | string[]) => unknown;
-declare const updateObjectDeepValue: (field: Record<string, unknown>, changeKey: string, value: unknown) => void;
-type ResultArrayType = KeyMap[];
-type ResultObjectType = Record<ObjectKey, KeyMap[]>;
+declare const getObjectDeepValue: (field: unknown, keys: string | string[]) => unknown;
+declare const updateObjectDeepValue: (field: KeyMap, changeKey: string, value: unknown) => void;
 declare const searchValueByKey: (result: ResultArrayType | ResultObjectType, id: ObjectKey, key: string) => unknown;
 declare const computeMatchedItemIndex: (itemId: ObjectKey, fieldArr: ResultArrayType, changingKey: string) => number;
 declare const combineArrayData: (fieldArray: ResultArrayType, value: ResultArrayType | Record<ObjectKey, KeyMap>, changingKey: string) => void;
@@ -235,4 +257,4 @@ declare const _default: {
     readonly DEFAULT_UNIQUE_KEY_NAME: "id";
 };
 
-export { type ApiResponse, type DefaultField, _default as ENUM, type FetchType, type FieldGetter, type FieldKeys, type FieldSetter, type GenerateParamsResp, type GenerateParamsType, type InitDataParams, type InitDataType, type InitStateParams, type InitStateType, type KeyMap, type LoadMoreParams, type LoadMoreType, type ObjectKey, type ResultArrayType$1 as ResultArrayType, type ResultObjectType$1 as ResultObjectType, type ResultType, type SetDataType, type SetErrorType, type SetterFuncParams, type UpdateStateType, initData, initState, loadMore, updateState, utils };
+export { type ApiFunction, type ApiResponse, type DataSource, type DefaultField, _default as ENUM, type FetchResultCallback, type FetchType, type FieldGetter, type FieldKeys, type FieldSetter, type GenerateParamsResp, type GenerateParamsType, type InitDataParams, type InitDataType, type InitStateParams, type InitStateType, type KeyMap, type LoadMoreParams, type LoadMoreType, type ObjectKey, type ResultArrayType, type ResultObjectType, type ResultType, type SetDataType, type SetErrorType, type SetterFuncParams, type UpdateStateParams, type UpdateStateType, initData, initState, loadMore, updateState, utils };

package/dist/index.global.js

@@ -59,9 +59,7 @@ var FlowList = (function (exports) {
   };
 
   // src/utils.ts
-  var isArray = (data) => {
-    return Array.isArray(data);
-  };
+  var isArray = (data) => Array.isArray(data);
   var stableSerialize = (value) => {
     if (value === null || typeof value !== "object") {
       return String(value);
@@ -72,7 +70,9 @@ var FlowList = (function (exports) {
       }
       const keys = Object.keys(value).sort();
       const obj = {};
-      for (const k of keys) {
+      const len = keys.length;
+      for (let i = 0; i < len; i++) {
+        const k = keys[i];
         obj[k] = value[k];
       }
       return JSON.stringify(obj);
@@ -82,13 +82,12 @@ var FlowList = (function (exports) {
   };
   var extractUniqueKey = (item, uniqueKey) => {
     if (typeof item !== "object" || item === null) return void 0;
-    const changing = uniqueKey || enum_default.DEFAULT_UNIQUE_KEY_NAME;
-    const val = item[changing] ?? void 0;
+    const val = item[uniqueKey];
     if (typeof val === "string" || typeof val === "number") {
       return val;
     }
-    if (typeof changing === "string" && changing.includes(".")) {
-      const deepVal = getObjectDeepValue(item, changing);
+    if (uniqueKey.includes(".")) {
+      const deepVal = getObjectDeepValue(item, uniqueKey);
       if (typeof deepVal === "string" || typeof deepVal === "number") {
         return deepVal;
       }
@@ -102,17 +101,15 @@ var FlowList = (function (exports) {
     return !Object.prototype.hasOwnProperty.call(data, "result");
   };
   var generateDefaultField = (opts = {}) => ({
-    ...{
-      result: [],
-      noMore: false,
-      nothing: false,
-      loading: false,
-      error: null,
-      extra: null,
-      fetched: false,
-      page: 0,
-      total: 0
-    },
+    result: [],
+    noMore: false,
+    nothing: false,
+    loading: false,
+    error: null,
+    extra: null,
+    fetched: false,
+    page: 0,
+    total: 0,
     ...opts
   });
   var generateFieldName = ({
@@ -121,20 +118,15 @@ var FlowList = (function (exports) {
     query = {}
   }) => {
     const funcName = typeof func === "string" ? func : (typeof func === "function" ? func.name : void 0) || `api-${Math.random().toString(36).substring(2, 8)}`;
-    const fetchType = type || "auto";
-    let result = `${funcName}-${fetchType}`;
-    const filteredKeys = Object.keys(query).filter(
-      (key) => query[key] !== void 0 && typeof query[key] !== "function" && ![
-        "page",
-        "is_up",
-        "since_id",
-        "seen_ids",
-        "__refresh__",
-        "__reload__"
-      ].includes(key)
-    );
+    let result = `${funcName}-${type || "auto"}`;
+    const filteredKeys = Object.keys(query).filter((key) => {
+      const value = query[key];
+      return value !== void 0 && typeof value !== "function" && key !== "page" && key !== "is_up" && key !== "since_id" && key !== "seen_ids" && key !== "__refresh__" && key !== "__reload__";
+    });
     filteredKeys.sort();
-    const querySuffix = filteredKeys.map((key) => {
+    const len = filteredKeys.length;
+    for (let i = 0; i < len; i++) {
+      const key = filteredKeys[i];
       const value = query[key];
       let safeValue;
       if (typeof value === "object" && value !== null) {
@@ -143,22 +135,22 @@ var FlowList = (function (exports) {
         safeValue = String(value);
       }
       const encoded = encodeURIComponent(safeValue);
-      return `-${key}-${encoded}`;
-    }).join("");
-    result += querySuffix;
+      result += `-${key}-${encoded}`;
+    }
     return result;
   };
-  var getObjectDeepValue = (field, keys = "") => {
+  var getObjectDeepValue = (field, keys) => {
     if (!keys || Array.isArray(keys) && keys.length === 0) {
       return field;
     }
     const keysArr = Array.isArray(keys) ? keys : keys.split(".");
     let result = field;
-    for (const key of keysArr) {
+    const len = keysArr.length;
+    for (let i = 0; i < len; i++) {
       if (result == null || typeof result !== "object") {
         return void 0;
       }
-      result = result[key];
+      result = result[keysArr[i]];
     }
     return result;
   };
@@ -167,7 +159,9 @@ var FlowList = (function (exports) {
     const keys = changeKey.split(".");
     const lastKey = keys.pop();
     let current = field;
-    for (const key of keys) {
+    const len = keys.length;
+    for (let i = 0; i < len; i++) {
+      const key = keys[i];
       if (current[key] == null || typeof current[key] !== "object") {
         current[key] = {};
       }
@@ -181,14 +175,12 @@ var FlowList = (function (exports) {
     if (isArray(result)) {
       const index = computeMatchedItemIndex(id, result, key);
       return index >= 0 ? result[index] : void 0;
-    } else {
-      return result[id];
     }
+    return result[String(id)];
   };
   var computeMatchedItemIndex = (itemId, fieldArr, changingKey) => {
     const stringifiedItemId = String(itemId);
-    const len = fieldArr?.length;
-    if (typeof len !== "number" || len <= 0) return -1;
+    const len = fieldArr.length;
     for (let i = 0; i < len; i++) {
       const item = fieldArr[i];
       if (typeof item !== "object" || item === null) continue;
@@ -201,7 +193,8 @@ var FlowList = (function (exports) {
   };
   var combineArrayData = (fieldArray, value, changingKey) => {
     const fieldArrayMap = /* @__PURE__ */ new Map();
-    for (let i = 0; i < fieldArray.length; i++) {
+    const arrLen = fieldArray.length;
+    for (let i = 0; i < arrLen; i++) {
       const item = fieldArray[i];
       if (typeof item !== "object" || item === null) continue;
       const id = getObjectDeepValue(item, changingKey);
@@ -210,20 +203,24 @@ var FlowList = (function (exports) {
       }
     }
     if (isArray(value)) {
-      for (const col of value) {
+      const valLen = value.length;
+      for (let i = 0; i < valLen; i++) {
+        const col = value[i];
         if (typeof col !== "object" || col === null) continue;
         const stringifyId = String(getObjectDeepValue(col, changingKey));
         const index = fieldArrayMap.get(stringifyId);
-        if (index !== void 0 && index !== -1) {
+        if (index !== void 0) {
           fieldArray[index] = { ...fieldArray[index], ...col };
         }
       }
     } else {
-      for (const [uniqueId, col] of Object.entries(value)) {
+      const entries = Object.entries(value);
+      const entLen = entries.length;
+      for (let i = 0; i < entLen; i++) {
+        const [uniqueId, col] = entries[i];
         if (typeof col !== "object" || col === null) continue;
-        const stringifyId = String(uniqueId);
-        const index = fieldArrayMap.get(stringifyId);
-        if (index !== void 0 && index !== -1) {
+        const index = fieldArrayMap.get(uniqueId);
+        if (index !== void 0) {
           fieldArray[index] = { ...fieldArray[index], ...col };
         }
       }
@@ -261,7 +258,10 @@ var FlowList = (function (exports) {
       target = {};
       field.result = target;
     }
-    Object.keys(valueObj).forEach((subKey) => {
+    const keys = Object.keys(valueObj);
+    const len = keys.length;
+    for (let i = 0; i < len; i++) {
+      const subKey = keys[i];
       const existing = target[subKey];
       const incoming = valueObj[subKey];
       if (existing !== void 0) {
@@ -273,7 +273,7 @@ var FlowList = (function (exports) {
       } else {
         target[subKey] = incoming;
       }
-    });
+    }
   };
   var computeResultLength = (data) => {
     if (isArray(data)) {
@@ -281,9 +281,11 @@ var FlowList = (function (exports) {
     }
     if (data && typeof data === "object") {
       let acc = 0;
-      for (const val of Object.values(data)) {
-        if (isArray(val)) {
-          acc += val.length;
+      const values = Object.values(data);
+      const len = values.length;
+      for (let i = 0; i < len; i++) {
+        if (isArray(values[i])) {
+          acc += values[i].length;
         }
       }
       return acc;
@@ -293,8 +295,9 @@ var FlowList = (function (exports) {
   var getSeenIdsString = (arr, uniqueKey) => {
     if (!isArray(arr)) return "";
     const ids = [];
-    for (const item of arr) {
-      const id = extractUniqueKey(item, uniqueKey);
+    const len = arr.length;
+    for (let i = 0; i < len; i++) {
+      const id = extractUniqueKey(arr[i], uniqueKey);
       if (id !== void 0) {
         ids.push(id);
       }
@@ -303,11 +306,11 @@ var FlowList = (function (exports) {
   };
   var generateRequestParams = ({
     field,
-    uniqueKey,
+    uniqueKey = enum_default.DEFAULT_UNIQUE_KEY_NAME,
     query = {},
     type
   }) => {
-    const result = {};
+    const result = { ...query };
     const isFetched = field.fetched;
     const getSafeObjectKey = (item) => {
       return extractUniqueKey(item, uniqueKey);
@@ -355,10 +358,7 @@ var FlowList = (function (exports) {
         result.page = 1;
       }
     }
-    return {
-      ...query,
-      ...result
-    };
+    return result;
   };
 
   // src/setters.ts
@@ -422,9 +422,7 @@ var FlowList = (function (exports) {
       setter({
         key: fieldName,
         type: enum_default.SETTER_TYPE.RESET,
-        // or MUTATE if you have such type
         value: field,
-        // same reference
         callback: () => {
           resolve();
         }
@@ -572,7 +570,6 @@ var FlowList = (function (exports) {
     query,
     type,
     func,
-    // string | function
     api,
     uniqueKey,
     errorRetry,
@@ -662,7 +659,6 @@ var FlowList = (function (exports) {
     getter,
     setter,
     func,
-    // string only
     type,
     query,
     method,
@@ -775,10 +771,7 @@ var FlowList = (function (exports) {
                 const idSet = new Set(_id);
                 modifyValue = modifyValue.filter(
                   (item) => !idSet.has(
-                    getObjectDeepValue(
-                      item,
-                      _uniqueKey
-                    )
+                    getObjectDeepValue(item, _uniqueKey)
                   )
                 );
               }
@@ -796,7 +789,11 @@ var FlowList = (function (exports) {
             break;
           case enum_default.CHANGE_TYPE.RESULT_LIST_MERGE:
             if (isArray(modifyValue)) {
-              combineArrayData(modifyValue, value, _uniqueKey);
+              combineArrayData(
+                modifyValue,
+                value,
+                _uniqueKey
+              );
             }
             break;
           default: