@vef-framework-react/starter 2.1.0

package/dist/types/src/types/api.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Base identifiable entity with unique identifier
+ *
+ * @template TId - Identifier type, defaults to string
+ */
+export interface IdEntity<TId = string> {
+    /**
+     * Unique identifier of the entity
+     */
+    id: TId;
+}
+/**
+ * Entity with creation tracking information
+ * Extends IdEntity with creation timestamp and creator details
+ *
+ * @template TId - Identifier type, defaults to string
+ * @template TDate - Date type, defaults to string (compatible with most API response formats)
+ */
+export interface CreatedEntity<TId = string, TDate = string> extends IdEntity<TId> {
+    /**
+     * Creation timestamp
+     */
+    createdAt: TDate;
+    /**
+     * Creator user ID
+     */
+    createdBy: TId;
+    /**
+     * Creator user name
+     */
+    createdByName: string;
+}
+/**
+ * Auditable entity with complete creation and update tracking information
+ * Extends CreatedEntity with update timestamp and updater details
+ * Suitable for business entities that require full audit trails
+ *
+ * @template TId - Identifier type, defaults to string
+ * @template TDate - Date type, defaults to string (compatible with most API response formats)
+ */
+export interface AuditedEntity<TId = string, TDate = string> extends CreatedEntity<TId, TDate> {
+    /**
+     * Last update timestamp
+     */
+    updatedAt: TDate;
+    /**
+     * Last updater user ID
+     */
+    updatedBy: TId;
+    /**
+     * Last updater user name
+     */
+    updatedByName: string;
+}
+/**
+ * Wrapper type for batch operations (create/update)
+ * Provides a convenient way to define parameters for APIs that handle multiple items at once
+ *
+ * @template T - The type of items in the batch operation
+ * @example
+ * ```typescript
+ * // API parameter for batch creating users
+ * interface CreateManyUsersParams extends Many<CreateUserParams> {}
+ *
+ * // API parameter for batch updating products
+ * interface UpdateManyProductsParams extends Many<UpdateProductParams> {}
+ * ```
+ */
+export interface Many<T> {
+    /**
+     * List of items to be processed in the batch operation
+     */
+    list: T[];
+}

package/dist/types/src/types/common.d.ts

@@ -0,0 +1,23 @@
+import { LiteralUnion, MaybeNull } from '@vef-framework-react/shared';
+export type Gender = "male" | "female" | "unknown";
+export type UserMenuType = LiteralUnion<"directory" | "menu" | "view" | "report", string>;
+export interface UserMenu {
+    type: UserMenuType;
+    path: string;
+    name: string;
+    icon?: MaybeNull<string>;
+    meta?: MaybeNull<Record<string, unknown>>;
+    children?: MaybeNull<UserMenu[]>;
+}
+export interface UserInfo {
+    id: string;
+    name: string;
+    gender: Gender;
+    avatar?: MaybeNull<string>;
+    permTokens: string[];
+    menus: UserMenu[];
+}
+export interface OrderSpec {
+    column: string;
+    direction: "asc" | "desc";
+}

package/dist/types/src/types/index.d.ts

@@ -0,0 +1,3 @@
+export type * from './api';
+export type * from './common';
+export type * from './router';

package/dist/types/src/types/router.d.ts

@@ -0,0 +1,5 @@
+import { AnyRouter } from '@tanstack/react-router';
+export interface RouterContext {
+    router: AnyRouter;
+    routeTitle?: string;
+}

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@vef-framework-react/starter",
+  "type": "module",
+  "version": "2.1.0",
+  "private": false,
+  "description": "Starter for VEF framework",
+  "author": {
+    "name": "Venus",
+    "email": "iweixiaopeng@163.com",
+    "url": "https://github.com/ilxqx"
+  },
+  "license": "Apache-2.0",
+  "homepage": "https://vef.ilxqx.com",
+  "keywords": [
+    "vef",
+    "framework",
+    "react",
+    "starter"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "vef": "./src/index.ts",
+      "import": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/es/index.js"
+      },
+      "require": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/cjs/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/es/index.js",
+  "types": "dist/types/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=22.x"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@tanstack/react-router": ">=1",
+    "@vef-framework-react/components": ">=2",
+    "@vef-framework-react/core": ">=2",
+    "@vef-framework-react/hooks": ">=2",
+    "@vef-framework-react/shared": ">=2",
+    "react": ">=19",
+    "react-dom": ">=19"
+  },
+  "dependencies": {
+    "@ant-design/icons": "^6.1.0",
+    "@emotion/react": "^11.14.0",
+    "@tanem/react-nprogress": "^6.0.3",
+    "compare-versions": "^6.1.1",
+    "lucide-react": "^1.6.0"
+  },
+  "devDependencies": {
+    "@tanstack/react-router": "^1.168.3",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4",
+    "@vef-framework-react/components": "2.1.0",
+    "@vef-framework-react/core": "2.1.0",
+    "@vef-framework-react/hooks": "2.1.0",
+    "@vef-framework-react/shared": "2.1.0"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "typecheck": "tsc --noEmit",
+    "build": "vite build"
+  }
+}