@flowlist/js-core 1.7.5 → 2.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowlist/js-core",
-  "version": "1.7.5",
+  "version": "2.1.0",
   "main": "dist/js-core.umd.js",
   "module": "dist/js-core.es.js",
   "types": "dist/index.d.ts",
@@ -31,25 +31,26 @@
     "lint": "eslint --ext js,jsx,ts,tsx,vue . --fix"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^4.18.0",
-    "@typescript-eslint/parser": "^4.18.0",
-    "@vue/eslint-config-prettier": "^6.0.0",
-    "@vue/eslint-config-typescript": "^7.0.0",
-    "eslint": "^6.7.2",
-    "eslint-plugin-prettier": "^3.3.1",
-    "eslint-plugin-vue": "^7.0.0",
     "@babel/preset-env": "^7.14.7",
     "@babel/preset-typescript": "^7.14.5",
-    "@types/jest": "^26.0.24",
-    "@vue/cli-plugin-unit-jest": "~4.5.11",
-    "@vue/cli-service": "~4.5.11",
-    "@vue/test-utils": "^1.1.3",
-    "faker": "^5.4.0",
+    "@faker-js/faker": "^6.1.2",
+    "@types/jest": "^27.4.1",
+    "@typescript-eslint/eslint-plugin": "^5.19.0",
+    "@typescript-eslint/parser": "^5.19.0",
+    "@vue/cli-plugin-unit-jest": "~5.0.4",
+    "@vue/cli-service": "~5.0.4",
+    "@vue/eslint-config-prettier": "^7.0.0",
+    "@vue/eslint-config-typescript": "^10.0.0",
+    "@vue/test-utils": "^2.0.0-rc.19",
+    "eslint": "^8.13.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-vue": "^8.6.0",
     "jest-localstorage-mock": "^2.4.8",
-    "ts-babel": "^6.1.7",
     "prettier": "^2.3.2",
-    "typescript": "^3.0.0",
+    "ts-babel": "^6.1.7",
+    "ts-jest": "^27.1.4",
+    "typescript": "^4.6.3",
     "vite": "^2.3.8",
-    "vite-plugin-dts": "^0.5.2"
+    "vite-plugin-dts": "^1.0.5"
   }
 }

package/src/actions.ts

@@ -25,8 +25,8 @@ export const initState = ({
   setter,
   func,
   type,
-  query = {},
-  opts = {}
+  query,
+  opts
 }: initStateType): Promise<null> => {
   return new Promise((resolve) => {
     const fieldName = generateFieldName({ func, type, query })
@@ -50,20 +50,18 @@ export const initState = ({
 export const initData = ({
   getter,
   setter,
-  cache,
   func,
   type,
-  query = {},
+  query,
   api,
-  cacheTimeout,
   uniqueKey,
   callback
 }: initDataType): Promise<any> =>
   new Promise((resolve, reject) => {
     const fieldName = generateFieldName({ func, type, query })
     const fieldData = getter(fieldName)
-    const doRefresh = !!query.__refresh__
-    const needReset = !!query.__reload__
+    const doRefresh = !!query?.__refresh__
+    const needReset = !!query?.__reload__
     // 如果 error 了，就不再请求
     if (fieldData && fieldData.error && !doRefresh) {
       return resolve(null)
@@ -87,7 +85,6 @@ export const initData = ({
       query,
       type
     })
-    let fromLocal = false
 
     const getData = () => {
       const loadData = () =>
@@ -103,19 +100,7 @@ export const initData = ({
               })
           }
 
-          if (cacheTimeout && cache) {
-            cache
-              .get({ key: fieldName })
-              .then((data) => {
-                fromLocal = true
-                res(data)
-              })
-              .catch(() => {
-                getDataFromAPI()
-              })
-          } else {
-            getDataFromAPI()
-          }
+          getDataFromAPI()
         })
 
       loadData().then((data) => {
@@ -123,12 +108,9 @@ export const initData = ({
           SET_DATA({
             getter,
             setter,
-            cache,
             data,
             fieldName,
             type,
-            fromLocal,
-            cacheTimeout,
             page: params.page || 0,
             insertBefore: false
           }).then(() => {
@@ -177,12 +159,10 @@ export const initData = ({
 export const loadMore = ({
   getter,
   setter,
-  cache,
-  query = {},
+  query,
   type,
   func,
   api,
-  cacheTimeout,
   uniqueKey,
   errorRetry,
   callback
@@ -207,7 +187,11 @@ export const loadMore = ({
       return resolve(null)
     }
 
-    if (type === ENUM.FETCH_TYPE.PAGINATION && +query.page === fieldData.page) {
+    if (
+      type === ENUM.FETCH_TYPE.PAGINATION &&
+      query &&
+      +query.page === fieldData.page
+    ) {
       return resolve(null)
     }
 
@@ -245,14 +229,11 @@ export const loadMore = ({
           SET_DATA({
             getter,
             setter,
-            cache,
             data,
             fieldName,
             type,
-            fromLocal: false,
-            cacheTimeout,
             page: params.page || 0,
-            insertBefore: !!query.is_up
+            insertBefore: !!query?.is_up
           }).then(() => {
             if (callback) {
               callback({
@@ -281,16 +262,14 @@ export const loadMore = ({
 export const updateState = ({
   getter,
   setter,
-  cache,
   type,
   func,
-  query = {},
+  query,
   method,
   value,
   id,
   uniqueKey,
-  changeKey,
-  cacheTimeout
+  changeKey
 }: updateStateType) => {
   return new Promise((resolve, reject) => {
     const fieldName = generateFieldName({ func, type, query })
@@ -300,6 +279,11 @@ export const updateState = ({
       return
     }
 
+    if (fieldData.page === -1) {
+      resolve(null)
+      return
+    }
+
     const _id = id || ''
     const _uniqueKey = uniqueKey || ENUM.DEFAULT_UNIQUE_KEY_NAME
     const _changeKey = changeKey || ENUM.FIELD_DATA.RESULT_KEY
@@ -397,18 +381,6 @@ export const updateState = ({
       type: ENUM.SETTER_TYPE.MERGE,
       value: fieldData,
       callback: () => {
-        if (cacheTimeout && cache) {
-          cache
-            .set({
-              key: fieldName,
-              value: fieldData,
-              timeout: cacheTimeout
-            })
-            .then(resolve)
-            .catch(resolve)
-          return
-        }
-
         resolve(null)
       }
     })

package/src/setters.ts

@@ -1,50 +1,48 @@
-import { computeResultLength, setReactivityField } from './utils'
+import { computeResultLength, setReactivityField, isObjectResult } from './utils'
 import ENUM from './enum'
 import type { setDataType, setErrorType } from './types'
 
 export const SET_DATA = ({
   getter,
   setter,
-  cache,
   data,
   fieldName,
   type,
-  fromLocal,
-  cacheTimeout,
   page,
   insertBefore
 }: setDataType): Promise<any> => {
   return new Promise((resolve, reject) => {
-    if (fromLocal) {
-      setter({
-        key: fieldName,
-        type: ENUM.SETTER_TYPE.RESET,
-        value: data,
-        callback: () => {
-          resolve(null)
-        }
-      })
-      return
-    }
-
     const fieldData = getter(fieldName)
     if (!fieldData) {
       reject()
       return
     }
 
-    const { result, extra } = data
-    const isEmpty = computeResultLength(result) === 0
-    fieldData.nothing = fieldData.fetched ? false : isEmpty
-    fieldData.fetched = true
-    fieldData.total = data.total || 0
-    if (type === ENUM.FETCH_TYPE.PAGINATION) {
-      fieldData.noMore = false
-      fieldData.page = +page
+    let result
+    let extra
+
+    if (isObjectResult(data)) {
+      result = data
+      fieldData.nothing = false
+      fieldData.fetched = true
+      fieldData.noMore = true
+      fieldData.page = -1
     } else {
-      fieldData.noMore = data.no_more || isEmpty
-      fieldData.page = fieldData.page + 1
+      result = data.result
+      extra = data.extra
+      const isEmpty = computeResultLength(result) === 0
+      fieldData.nothing = fieldData.fetched ? false : isEmpty
+      fieldData.fetched = true
+      fieldData.total = data.total || 0
+      if (type === ENUM.FETCH_TYPE.PAGINATION) {
+        fieldData.noMore = false
+        fieldData.page = +page
+      } else {
+        fieldData.noMore = data.no_more || isEmpty
+        fieldData.page = fieldData.page + 1
+      }
     }
+
     fieldData.loading = false
     setReactivityField(
       fieldData,
@@ -68,18 +66,6 @@ export const SET_DATA = ({
       type: ENUM.SETTER_TYPE.RESET,
       value: fieldData,
       callback: () => {
-        if (cacheTimeout && cache && !fieldData.nothing) {
-          cache
-            .set({
-              key: fieldName,
-              value: fieldData,
-              timeout: cacheTimeout
-            })
-            .then(resolve)
-            .catch(resolve)
-          return
-        }
-
         resolve(null)
       }
     })

package/src/types.ts

@@ -33,13 +33,13 @@ export type fieldKeys =
 export type generateFieldProps = {
   func: string | (() => {})
   type: fetchTypes
-  query: keyMap
+  query?: keyMap
 }
 
 export type generateParamsType = {
   field: defaultField
   uniqueKey: string
-  query: keyMap
+  query?: keyMap
   type: fetchTypes
 }
 
@@ -66,24 +66,9 @@ export type initStateType = {
   opts?: keyMap
 }
 
-export type cacheType = {
-  get: ({ key }: { key: string }) => Promise<any>
-  set: ({
-    key,
-    value,
-    timeout
-  }: {
-    key: string
-    value: any
-    timeout?: number
-  }) => Promise<any>
-  del: ({ key }: { key: string }) => void
-}
-
 export type initDataType = {
   getter: (str: string) => defaultField
   setter: (obj: setterFuncParams) => void
-  cache: cacheType
   func: string | (() => {})
   type: fetchTypes
   query?: keyMap
@@ -96,7 +81,6 @@ export type initDataType = {
 export type loadMoreType = {
   getter: (str: string) => defaultField
   setter: (obj: setterFuncParams) => void
-  cache: cacheType
   func: string | (() => {})
   type: fetchTypes
   query?: keyMap
@@ -110,7 +94,6 @@ export type loadMoreType = {
 export type updateStateType = {
   getter: (str: string) => defaultField
   setter: (obj: setterFuncParams) => void
-  cache: cacheType
   func: string | (() => {})
   type: fetchTypes
   query?: keyMap
@@ -120,18 +103,14 @@ export type updateStateType = {
   changeKey: string
   cacheTimeout: number
   uniqueKey: string
-  callback: (obj?: keyMap) => void
 }
 
 export type setDataType = {
   getter: (str: string) => defaultField
   setter: (obj: setterFuncParams) => void
-  cache: cacheType
   data: any
   fieldName: string
   type: fetchTypes
-  fromLocal: boolean
-  cacheTimeout: number
   page: number
   insertBefore: boolean
 }

package/src/utils.ts

@@ -12,6 +12,10 @@ import type {
   generateParamsResp
 } from './types'
 
+export const isObjectResult = (data: Record<string, any>): boolean => {
+  return data.result === undefined
+}
+
 export const generateDefaultField = (opts = {}): defaultField => ({
   ...{
     result: [],
@@ -27,7 +31,6 @@ export const generateDefaultField = (opts = {}): defaultField => ({
   ...opts
 })
 
-let seed = 0
 /**
  * 根据参数生成 field 的 namespace
  * @param {string} func
@@ -40,7 +43,10 @@ export const generateFieldName = ({
   type,
   query = {}
 }: generateFieldProps): string => {
-  func = typeof func === 'string' ? func : `custom-func-${seed++}`
+  func =
+    typeof func === 'string'
+      ? func
+      : `api-${Math.random().toString(36).substring(2)}`
   type = type || 'auto'
   let result = `${func}-${type}`
   Object.keys(query)
@@ -263,11 +269,10 @@ export const computeResultLength = (data: fieldResult): number => {
 export const generateRequestParams = ({
   field,
   uniqueKey,
-  query,
+  query = {},
   type
 }: generateParamsType): generateParamsResp => {
   const result: generateParamsResp = {}
-  query = query || {}
   if (field.fetched) {
     const changing = uniqueKey || ENUM.DEFAULT_UNIQUE_KEY_NAME
     if (type === ENUM.FETCH_TYPE.AUTO) {

package/dist/src/actions.d.ts

@@ -1,5 +0,0 @@
-import type { initStateType, initDataType, loadMoreType, updateStateType } from './types';
-export declare const initState: ({ getter, setter, func, type, query, opts }: initStateType) => Promise<null>;
-export declare const initData: ({ getter, setter, cache, func, type, query, api, cacheTimeout, uniqueKey, callback }: initDataType) => Promise<any>;
-export declare const loadMore: ({ getter, setter, cache, query, type, func, api, cacheTimeout, uniqueKey, errorRetry, callback }: loadMoreType) => Promise<any>;
-export declare const updateState: ({ getter, setter, cache, type, func, query, method, value, id, uniqueKey, changeKey, cacheTimeout }: updateStateType) => Promise<unknown>;

package/dist/src/enum.d.ts

@@ -1,32 +0,0 @@
-declare const _default: {
-    SETTER_TYPE: {
-        RESET: number;
-        MERGE: number;
-    };
-    FETCH_TYPE_ARRAY: string[];
-    FETCH_TYPE: {
-        PAGINATION: string;
-        SINCE_FIRST_OR_END_ID: string;
-        SCROLL_LOAD_MORE: string;
-        HAS_LOADED_IDS: string;
-        AUTO: string;
-    };
-    CHANGE_TYPE: {
-        SEARCH_FIELD: string;
-        RESET_FIELD: string;
-        RESULT_UPDATE_KV: string;
-        RESULT_ADD_AFTER: string;
-        RESULT_ADD_BEFORE: string;
-        RESULT_REMOVE_BY_ID: string;
-        RESULT_INSERT_TO_BEFORE: string;
-        RESULT_INSERT_TO_AFTER: string;
-        RESULT_LIST_MERGE: string;
-        RESULT_ITEM_MERGE: string;
-    };
-    FIELD_DATA: {
-        RESULT_KEY: string;
-        EXTRA_KEY: string;
-    };
-    DEFAULT_UNIQUE_KEY_NAME: string;
-};
-export default _default;

package/dist/src/index.d.ts

@@ -1,4 +0,0 @@
-export * from './actions';
-export * as utils from './utils';
-export { default as ENUM } from './enum';
-export * from './types';

package/dist/src/setters.d.ts

@@ -1,3 +0,0 @@
-import type { setDataType, setErrorType } from './types';
-export declare const SET_DATA: ({ getter, setter, cache, data, fieldName, type, fromLocal, cacheTimeout, page, insertBefore }: setDataType) => Promise<any>;
-export declare const SET_ERROR: ({ setter, fieldName, error }: setErrorType) => void;

package/dist/src/types.d.ts

@@ -1,118 +0,0 @@
-export declare type objectKey = string | number;
-export declare type keyMap = Record<objectKey, any>;
-export declare type morphArray = any[];
-export declare type fieldResult = morphArray | keyMap;
-export declare type defaultField = {
-    result: fieldResult;
-    noMore: boolean;
-    nothing: boolean;
-    loading: boolean;
-    error: null | Error;
-    extra: null | any;
-    fetched: boolean;
-    page: number;
-    total: number;
-};
-export declare type fetchTypes = 'jump' | 'sinceId' | 'page' | 'seenIds' | 'auto';
-export declare type fieldKeys = 'result' | 'noMore' | 'nothing' | 'loading' | 'error' | 'extra' | 'page' | 'total';
-export declare type generateFieldProps = {
-    func: string | (() => {});
-    type: fetchTypes;
-    query: keyMap;
-};
-export declare type generateParamsType = {
-    field: defaultField;
-    uniqueKey: string;
-    query: keyMap;
-    type: fetchTypes;
-};
-export declare type generateParamsResp = {
-    seen_ids?: string;
-    since_id?: objectKey;
-    is_up?: 0 | 1;
-    page?: number;
-};
-export declare type setterFuncParams = {
-    key: string;
-    type: number;
-    value: any;
-    callback?: (obj?: keyMap) => void;
-};
-export declare type initStateType = {
-    getter: (str: string) => defaultField;
-    setter: (obj: setterFuncParams) => void;
-    func: string | (() => {});
-    type: fetchTypes;
-    query?: keyMap;
-    opts?: keyMap;
-};
-export declare type cacheType = {
-    get: ({ key }: {
-        key: string;
-    }) => Promise<any>;
-    set: ({ key, value, timeout }: {
-        key: string;
-        value: any;
-        timeout?: number;
-    }) => Promise<any>;
-    del: ({ key }: {
-        key: string;
-    }) => void;
-};
-export declare type initDataType = {
-    getter: (str: string) => defaultField;
-    setter: (obj: setterFuncParams) => void;
-    cache: cacheType;
-    func: string | (() => {});
-    type: fetchTypes;
-    query?: keyMap;
-    api: keyMap;
-    cacheTimeout: number;
-    uniqueKey: string;
-    callback: (obj?: keyMap) => void;
-};
-export declare type loadMoreType = {
-    getter: (str: string) => defaultField;
-    setter: (obj: setterFuncParams) => void;
-    cache: cacheType;
-    func: string | (() => {});
-    type: fetchTypes;
-    query?: keyMap;
-    api: keyMap;
-    cacheTimeout: number;
-    uniqueKey: string;
-    errorRetry: boolean;
-    callback: (obj?: keyMap) => void;
-};
-export declare type updateStateType = {
-    getter: (str: string) => defaultField;
-    setter: (obj: setterFuncParams) => void;
-    cache: cacheType;
-    func: string | (() => {});
-    type: fetchTypes;
-    query?: keyMap;
-    method: string;
-    value: any;
-    id: string | number | objectKey[];
-    changeKey: string;
-    cacheTimeout: number;
-    uniqueKey: string;
-    callback: (obj?: keyMap) => void;
-};
-export declare type setDataType = {
-    getter: (str: string) => defaultField;
-    setter: (obj: setterFuncParams) => void;
-    cache: cacheType;
-    data: any;
-    fieldName: string;
-    type: fetchTypes;
-    fromLocal: boolean;
-    cacheTimeout: number;
-    page: number;
-    insertBefore: boolean;
-};
-export declare type setErrorType = {
-    setter: (obj: setterFuncParams) => void;
-    fieldName: string;
-    error: null | Error;
-};

package/dist/src/utils.d.ts

@@ -1,58 +0,0 @@
-import type { objectKey, keyMap, morphArray, fieldResult, defaultField, fetchTypes, fieldKeys, generateFieldProps, generateParamsType, generateParamsResp } from './types';
-export declare const generateDefaultField: (opts?: {}) => defaultField;
-/**
- * 根据参数生成 field 的 namespace
- * @param {string} func
- * @param {string} type
- * @param {object} query
- * @return {string}
- */
-export declare const generateFieldName: ({ func, type, query }: generateFieldProps) => string;
-/**
- * 根据 key 从 object 里拿 value
- * @param {object} field
- * @param {string} keys
- * @return {*}
- */
-export declare const getObjectDeepValue: (field: keyMap, keys: string | string[]) => any;
-export declare const updateObjectDeepValue: (field: keyMap, changeKey: string, value: any) => void;
-export declare const searchValueByKey: (result: fieldResult, id: objectKey, key: objectKey) => any;
-/**
- * 通过 id 匹配返回数组中某个对象的 index
- * @param {int|string} itemId
- * @param {array} fieldArr
- * @param {int|string} changingKey
- * @return {number}
- */
-export declare const computeMatchedItemIndex: (itemId: objectKey, fieldArr: morphArray, changingKey: objectKey) => number;
-export declare const combineArrayData: (fieldArray: any[], value: fieldResult, changingKey: string) => void;
-/**
- * 判断参数是否为数组
- * @param {object|array} data
- * @return {boolean}
- */
-export declare const isArray: (data: any) => boolean;
-/**
- * 设置一个响应式的数据到对象上
- * @param {object} field
- * @param {string} key
- * @param {array|object} value
- * @param {string} type
- * @param {boolean} insertBefore
- */
-export declare const setReactivityField: (field: defaultField, key: fieldKeys, value: any, type: fetchTypes, insertBefore: boolean) => void;
-/**
- * 计算一个数据列的长度
- * @param {array|object} data
- * @return {number}
- */
-export declare const computeResultLength: (data: fieldResult) => number;
-/**
- * 拼接请求的参数
- * @param {object} field
- * @param {string} uniqueKey
- * @param {object} query
- * @param {string} type
- * @return {object}
- */
-export declare const generateRequestParams: ({ field, uniqueKey, query, type }: generateParamsType) => generateParamsResp;