@kine-design/crud 0.0.1-beta.1

package/dist/composables/types.d.ts

@@ -0,0 +1,68 @@
+import { MaybeRef } from 'vue';
+/** 通用列表请求参数 */
+export type ListParams = Record<string, unknown>;
+/** 通用 ID 类型 */
+export type EntityId = string | number;
+export interface RepositoryEndpoints<TList, TDetail, TCreateInput, TCreateOutput, TUpdateInput, TUpdateOutput> {
+    /** 列表查询 */
+    list?: (params: ListParams) => Promise<TList>;
+    /** 单条详情查询 */
+    detail?: (id: EntityId) => Promise<TDetail>;
+    /** 创建 */
+    create?: (data: TCreateInput) => Promise<TCreateOutput>;
+    /** 更新 */
+    update?: (id: EntityId, data: TUpdateInput) => Promise<TUpdateOutput>;
+    /** 删除 */
+    remove?: (id: EntityId) => Promise<void>;
+}
+/** mutation 共用选项 */
+export interface MutationOptions {
+    /**
+     * 跨领域缓存失效声明。
+     * mutation 成功后除自身领域外，还会额外失效这些领域的所有 query。
+     */
+    invalidates?: string[];
+}
+/**
+ * useList 返回值（只暴露业务层常用字段，屏蔽 TanStack 底层细节）。
+ * 需要更多字段时可在此扩展。
+ */
+export interface UseListReturn<TData> {
+    data: import('vue').ComputedRef<TData | undefined>;
+    isLoading: import('vue').ComputedRef<boolean>;
+    isFetching: import('vue').ComputedRef<boolean>;
+    isError: import('vue').ComputedRef<boolean>;
+    error: import('vue').ComputedRef<Error | null>;
+    refetch: () => void;
+}
+/** useDetail 返回值 */
+export interface UseDetailReturn<TData> {
+    data: import('vue').ComputedRef<TData | undefined>;
+    isLoading: import('vue').ComputedRef<boolean>;
+    isFetching: import('vue').ComputedRef<boolean>;
+    isError: import('vue').ComputedRef<boolean>;
+    error: import('vue').ComputedRef<Error | null>;
+    refetch: () => void;
+}
+/** useMutation 返回值（create / update / remove 共用） */
+export interface UseMutationReturn<TVariables, TData> {
+    mutate: TVariables extends void ? () => Promise<TData> : (variables: TVariables) => Promise<TData>;
+    isPending: import('vue').ComputedRef<boolean>;
+    isError: import('vue').ComputedRef<boolean>;
+    error: import('vue').ComputedRef<Error | null>;
+}
+export interface Repository<TList, TDetail, TCreateInput, TCreateOutput, TUpdateInput, TUpdateOutput> {
+    /** 列表 query hook */
+    useList: (params?: MaybeRef<ListParams>) => UseListReturn<TList>;
+    /** 详情 query hook */
+    useDetail: (id: MaybeRef<EntityId>) => UseDetailReturn<TDetail>;
+    /** 创建 mutation hook */
+    useCreate: (options?: MutationOptions) => UseMutationReturn<TCreateInput, TCreateOutput>;
+    /** 更新 mutation hook */
+    useUpdate: (options?: MutationOptions) => UseMutationReturn<{
+        id: EntityId;
+        data: TUpdateInput;
+    }, TUpdateOutput>;
+    /** 删除 mutation hook */
+    useRemove: (options?: MutationOptions) => UseMutationReturn<EntityId, void>;
+}