@kine-design/crud 0.0.1-beta.1

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @description @kine-design/crud 入口
+ * @author 阿怪
+ * @date 2026/2/26
+ * @version v0.0.1
+ *
+ * 江湖的业务千篇一律，复杂的代码好几百行。
+ */
+export * from './components/layout';
+export { KSearchTable } from './components/searchTable';
+export { KLoginPage } from './components/login';
+export type { LoginForm } from './components/login';
+export { KPageHeader } from './components/pageHeader';
+export { defineRepository } from './composables/defineRepository';
+export { setupCrud, createCrudApp, createQueryClient, useRequestClient, REQUEST_CLIENT_KEY } from './setup';
+export type { CrudOptions, CrudAppOptions, EnhancedApp } from './setup';
+export type { EntityId, ListParams, MutationOptions, Repository, RepositoryEndpoints, UseListReturn, UseDetailReturn, UseMutationReturn, } from './composables/types';
+export { KNavMenu } from './components/navMenu';
+export type { NavMenuData } from './components/navMenu';
+export { KUpload, KImageUpload, KFileList } from './components/upload';
+export type { UploadFile, UploadRequest } from './components/upload';
+export { defineCrudRoutes, createTabStore, useTabStore, useMenuFromRoutes, createRouterGuard, addTabFromRoute, } from './composables/router';
+export type { CrudRouteMeta, CrudRouteConfig, CrudRouteRecord, TabItem, TabStore, RouteLocationLike, RouterGuard, RouterGuardOptions, } from './composables/router';
+export { createAuth, useAuth, createAuthGuard, createVCan, } from './composables/auth';
+export type { Permission, PermissionScope, UserInfo, AuthState, AuthOptions, AuthReturn, AuthGuardOptions, BeforeEachGuard, CanBinding, CanBindingObject, } from './composables/auth';
+export { createRequest, createDefaultRequest, createStrictRequest, createPermissiveRequest, createUploader, useRequest, usePolling, useBatchLoader, orchestrate, createNode, after, BusinessError, NetworkRequestError, ControlGate, FetchTransport, XhrTransport, RequestBuilder, } from './composables/request';
+export type { RequestMethod, ControlPolicy, CachePolicy, RetryPolicy, Lifecycle, RequestConfig, WrappedResponse, NetworkError, UserFeedbackHandler, Transport, TransportRequest, TransportResponse, RequestOptions, RequestClient, RequestBuilderContext, OrchestratorNode, FailureStrategy, OrchestratorResult, UploadOptions, UploaderOptions, UploadHandle, Uploader, UsePollingReturn, BatchLoaderOptions, UseBatchLoaderReturn, } from './composables/request';
+export { defineUserStore } from './composables/store';
+export type { UserStoreOptions, UserStore, LoginResult } from './composables/store';

package/dist/setup.d.ts

@@ -0,0 +1,95 @@
+import { App, Component } from 'vue';
+import { QueryClient, VueQueryPluginOptions } from '@tanstack/vue-query';
+import { RequestOptions } from './composables/request/types';
+import { RequestClient } from './composables/request/createRequest';
+import { ErrorHandlerOptions } from './composables/error/types';
+import { BeforeEachGuard } from './composables/auth/authGuard';
+/** 最小化 Router 接口，只声明本文件用到的方法 */
+interface RouterLike {
+    beforeEach(guard: BeforeEachGuard): void;
+    install(app: App): void;
+}
+/** setupCrud / createCrudApp 的配置选项 */
+export interface CrudOptions {
+    /**
+     * 自定义 QueryClient 实例。
+     * 不传时内部自动创建，使用合理的默认配置。
+     */
+    queryClient?: QueryClient;
+    /** 透传给 VueQueryPlugin 的其余选项（queryClient 字段会被覆盖）。 */
+    vueQueryOptions?: Omit<VueQueryPluginOptions, 'queryClient'>;
+}
+/** createCrudApp 高级版本的完整配置 */
+export interface CrudAppOptions {
+    /** Vue Router 实例 */
+    router?: RouterLike;
+    /** Auth 配置（传入后自动 createAuth + createAuthGuard + v-can 指令） */
+    auth?: {
+        fetchUser: () => Promise<{
+            user: import('./composables/auth/types').UserInfo;
+            permissions: import('./composables/auth/types').Permission[];
+            token: string;
+        }>;
+        onUnauthorized?: () => void;
+        storage?: 'local' | 'session' | false;
+        loginPath?: string;
+    };
+    /** Request 配置（传入后自动 createRequest 并挂载到 app.provide） */
+    request?: RequestOptions;
+    /** 错误处理配置 */
+    error?: ErrorHandlerOptions;
+    /** TanStack Query 配置 */
+    query?: CrudOptions;
+}
+/** provide/inject 使用的唯一 symbol key */
+export declare const REQUEST_CLIENT_KEY: symbol;
+/**
+ * 在组件中获取通过 createCrudApp 注入的 RequestClient。
+ *
+ * @throws 若未在 createCrudApp 中配置 request 选项，抛出错误。
+ */
+export declare function useRequestClient(): RequestClient;
+/**
+ * 创建一个预配置好的 QueryClient 实例（供高级场景直接使用）。
+ */
+export declare function createQueryClient(): QueryClient;
+/**
+ * 在 Vue App 实例上安装 CRUD 基础设施（TanStack Query）。
+ * 推荐在 main.ts 调用一次，业务代码无需再关心 TanStack Query 安装细节。
+ *
+ * @example
+ * ```ts
+ * // main.ts
+ * import { createApp } from 'vue';
+ * import { setupCrud } from '@kine-design/crud/setup';
+ *
+ * const app = createApp(App);
+ * setupCrud(app);
+ * app.mount('#app');
+ * ```
+ */
+export declare function setupCrud(app: App, options?: CrudOptions): void;
+/** 增强的 App 接口，mount 时自动恢复 auth 状态 */
+export interface EnhancedApp extends Omit<App, 'mount'> {
+    mount(rootContainer: string | Element): App;
+}
+/**
+ * createCrudApp — 链式风格的工厂函数，等同于 createApp + setupCrud。
+ *
+ * @example
+ * ```ts
+ * // 基础用法
+ * createCrudApp(App).mount('#app');
+ *
+ * // 高级用法：一站式初始化
+ * createCrudApp(App, {
+ *   router,
+ *   auth: { fetchUser, onUnauthorized: () => router.push('/login'), storage: 'local' },
+ *   request: { baseURL: '/api' },
+ *   error: { unauthorizedStrategy: 'redirect' },
+ * }).mount('#app');
+ * ```
+ */
+export declare function createCrudApp(rootComponent: Component, rootProps?: Record<string, unknown>, options?: CrudOptions): App;
+export declare function createCrudApp(rootComponent: Component, options: CrudAppOptions): EnhancedApp;
+export {};

package/dist/vite.config.build.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vite').UserConfig;
+export default _default;

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@kine-design/crud",
+  "version": "0.0.1-beta.1",
+  "type": "module",
+  "main": "./dist/crud.js",
+  "module": "./dist/crud.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/crud.js"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@tanstack/vue-query": "^5.92.9",
+    "pinia": "^3.0.3",
+    "vue": "^3.4.0",
+    "vue-router": "^4.6.4",
+    "@kine-design/core": "0.0.1-beta.1",
+    "kine-ui": "0.0.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "vite build --config vite.config.build.ts"
+  }
+}