@flowlist/js-core 4.0.7-beta.0 → 4.0.9-beta.0

package/dist/types.d.ts

@@ -0,0 +1,140 @@
+/** 对象的唯一标识符类型 */
+type ObjectKey = string | number;
+/** 通用对象结构 */
+type KeyMap = Record<string, any>;
+/** API 响应基础结构 */
+interface BaseApiResponse<TData = any> {
+    readonly result: TData;
+    readonly extra?: any;
+    readonly total?: number;
+    readonly no_more?: boolean;
+}
+/** 核心状态字段 */
+interface DefaultField<TData = any, TExtra = any> {
+    result: TData;
+    noMore: boolean;
+    nothing: boolean;
+    loading: boolean;
+    error: Error | null;
+    extra: TExtra | null;
+    fetched: boolean;
+    page: number;
+    total: number;
+}
+type FieldKeys = keyof DefaultField;
+/** 请求参数基础约束 */
+interface RequestParams {
+    [key: string]: any;
+    __refresh__?: boolean;
+    __reload__?: boolean;
+    page?: number;
+    sinceId?: ObjectKey;
+}
+/** 数据获取策略类型 */
+type FetchType = 'jump' | 'sinceId' | 'page' | 'seenIds' | 'auto';
+/** API 契约 */
+interface ApiContract<TParams extends RequestParams, TResponse> {
+    (params: TParams): Promise<BaseApiResponse<TResponse>>;
+    readonly id: string;
+    readonly type: FetchType;
+    readonly is_up: boolean;
+    readonly uniqueKey: string;
+    readonly paramsIgnore: string[];
+}
+type FieldGetter = (key: string) => DefaultField | undefined;
+interface SetterFuncParams {
+    readonly key: string;
+    readonly type: number;
+    readonly value: Partial<DefaultField> | DefaultField;
+    readonly callback?: (obj?: any) => void;
+}
+type FieldSetter = (obj: SetterFuncParams) => void;
+interface GenerateParamsResp extends RequestParams {
+    seen_ids?: string;
+    since_id?: ObjectKey;
+    is_up?: 0 | 1;
+    page?: number;
+    extra?: any;
+}
+interface GenerateParamsType {
+    readonly field: DefaultField;
+    readonly uniqueKey?: string;
+    readonly is_up?: boolean;
+    readonly query?: KeyMap;
+    readonly type: FetchType;
+}
+type FetchResultCallback<TParams, TResponse> = (obj: {
+    params: TParams;
+    data: BaseApiResponse<TResponse>;
+    refresh: boolean;
+}) => void;
+interface SetDataType {
+    readonly getter: FieldGetter;
+    readonly setter: FieldSetter;
+    readonly data: BaseApiResponse;
+    readonly fieldName: string;
+    readonly type: FetchType;
+    readonly page: number;
+    readonly insertBefore: boolean;
+}
+interface SetErrorType {
+    readonly setter: FieldSetter;
+    readonly fieldName: string;
+    readonly error: Error | null;
+}
+interface InitStateParams<P extends RequestParams = RequestParams, R = any> {
+    readonly func: ApiContract<P, R>;
+    readonly query?: P;
+    readonly opts?: Partial<DefaultField<R>>;
+}
+interface InitDataParams<P extends RequestParams = RequestParams, R = any> {
+    readonly func: ApiContract<P, R>;
+    readonly query?: P;
+    readonly callback?: FetchResultCallback<P, R>;
+}
+interface LoadMoreParams<P extends RequestParams = RequestParams, R = any> {
+    readonly func: ApiContract<P, R>;
+    readonly query?: P;
+    readonly errorRetry?: boolean;
+    readonly callback?: FetchResultCallback<P, R>;
+}
+interface UpdateStateParams<P extends RequestParams = RequestParams, R = any> {
+    readonly func: ApiContract<P, R>;
+    readonly query?: P;
+    readonly method: string;
+    readonly value: any;
+    readonly id?: ObjectKey | ObjectKey[];
+    readonly changeKey?: string;
+    readonly uniqueKey?: string;
+}
+interface InitStateType<P extends RequestParams, R> extends InitStateParams<P, R> {
+    readonly getter: FieldGetter;
+    readonly setter: FieldSetter;
+}
+interface InitDataType<P extends RequestParams, R> extends InitDataParams<P, R> {
+    readonly getter: FieldGetter;
+    readonly setter: FieldSetter;
+}
+interface LoadMoreType<P extends RequestParams, R> extends LoadMoreParams<P, R> {
+    readonly getter: FieldGetter;
+    readonly setter: FieldSetter;
+}
+interface UpdateStateType<P extends RequestParams, R> extends UpdateStateParams<P, R> {
+    readonly getter: FieldGetter;
+    readonly setter: FieldSetter;
+}
+interface MutationContext {
+    resultArray: any[] | null;
+    newFieldData: DefaultField;
+    _id: ObjectKey | ObjectKey[] | undefined;
+    _uniqueKey: string;
+    _changeKey: string;
+    value: any;
+}
+/** mutation handler 返回值：处理后的 modifyValue 或 undefined 表示已直接修改 newFieldData */
+type MutationHandler = (ctx: MutationContext) => {
+    resolved?: unknown;
+    modifyValue?: unknown;
+} | void;
+
+export type { ApiContract, BaseApiResponse, DefaultField, FetchResultCallback, FetchType, FieldGetter, FieldKeys, FieldSetter, GenerateParamsResp, GenerateParamsType, InitDataParams, InitDataType, InitStateParams, InitStateType, KeyMap, LoadMoreParams, LoadMoreType, MutationContext, MutationHandler, ObjectKey, RequestParams, SetDataType, SetErrorType, SetterFuncParams, UpdateStateParams, UpdateStateType };

package/dist/types.js

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"types.js"}

package/dist/types.mjs

@@ -0,0 +1,3 @@
+import './chunk-KIQOUUEZ.mjs';
+//# sourceMappingURL=types.mjs.map
+//# sourceMappingURL=types.mjs.map

package/dist/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"types.mjs"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowlist/js-core",
-  "version": "4.0.7-beta.0",
+  "version": "4.0.9-beta.0",
   "description": "flowlist frontend javascript core",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -16,6 +16,72 @@
         "default": "./dist/index.js"
       },
       "default": "./dist/index.js"
+    },
+    "./core": {
+      "import": {
+        "types": "./dist/core.d.mts",
+        "default": "./dist/core.mjs"
+      },
+      "require": {
+        "types": "./dist/core.d.ts",
+        "default": "./dist/core.js"
+      },
+      "default": "./dist/core.js"
+    },
+    "./constants": {
+      "import": {
+        "types": "./dist/constants.d.mts",
+        "default": "./dist/constants.mjs"
+      },
+      "require": {
+        "types": "./dist/constants.d.ts",
+        "default": "./dist/constants.js"
+      },
+      "default": "./dist/constants.js"
+    },
+    "./types": {
+      "import": {
+        "types": "./dist/types.d.mts",
+        "default": "./dist/types.mjs"
+      },
+      "require": {
+        "types": "./dist/types.d.ts",
+        "default": "./dist/types.js"
+      },
+      "default": "./dist/types.js"
+    },
+    "./mutations": {
+      "import": {
+        "types": "./dist/mutations/index.d.mts",
+        "default": "./dist/mutations/index.mjs"
+      },
+      "require": {
+        "types": "./dist/mutations/index.d.ts",
+        "default": "./dist/mutations/index.js"
+      },
+      "default": "./dist/mutations/index.js"
+    },
+    "./mutations/core": {
+      "import": {
+        "types": "./dist/mutations/core.d.mts",
+        "default": "./dist/mutations/core.mjs"
+      },
+      "require": {
+        "types": "./dist/mutations/core.d.ts",
+        "default": "./dist/mutations/core.js"
+      },
+      "default": "./dist/mutations/core.js"
+    },
+    "./mutations/extended": {
+      "import": {
+        "types": "./dist/mutations/extended.d.mts",
+        "default": "./dist/mutations/extended.mjs"
+      },
+      "require": {
+        "types": "./dist/mutations/extended.d.ts",
+        "default": "./dist/mutations/extended.js"
+      },
+      "default": "./dist/mutations/extended.js"
     }
   },
   "files": [