@zucker-framework/fe-types 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,22 @@
+Zucker Framework
+Copyright 2026 Lind and Zucker Framework contributors
+
+Licensed under the Apache License, Version 2.0. See LICENSE.
+
+The framework includes TypeScript adaptations and enhancements of concepts and
+implementations from hsweb-framework and jetlinks-community, both distributed
+under the Apache License, Version 2.0. Individual packages use different subsets
+of the framework. The TypeScript adaptations and Node.js integrations were
+modified for Zucker Framework; they are not the original upstream distribution.
+
+hsweb-framework
+https://github.com/hs-web/hsweb-framework
+Copyright 2020 http://hsweb.me
+
+jetlinks-community
+https://github.com/jetlinks/jetlinks-community
+
+See THIRD_PARTY_NOTICES for license texts and attribution for bundled dependencies
+and reference implementations relevant to this package. External dependencies
+remain subject to their own licenses. This NOTICE is informational and does not
+modify any license or grant rights to upstream trademarks.

package/THIRD_PARTY_NOTICES

@@ -0,0 +1,4 @@
+@zucker-framework/fe-types
+
+No separately recorded third-party implementation is bundled in this package.
+External dependencies retain their own licenses; see NOTICE for framework attribution.

package/dist/index.d.mts

@@ -0,0 +1,294 @@
+import { z } from 'zod/v4';
+
+/**
+ * Zod Schemas — 前后端共享的 Single Source of Truth
+ *
+ * 对标 Claude Code 的 Tool inputSchema/outputSchema 模式：
+ * 一个定义同时提供运行时验证和 TypeScript 类型推断。
+ *
+ * 用法:
+ * ```ts
+ * // 后端 — DTO 验证
+ * const data = UserSchema.parse(req.body);
+ *
+ * // 前端 — 表单验证
+ * const result = UserSchema.safeParse(formValues);
+ *
+ * // 类型推断（无需手动维护 interface）
+ * type User = z.infer<typeof UserSchema>;
+ * ```
+ */
+
+declare const UserSchema: z.ZodObject<{
+    id: z.ZodString;
+    username: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    email: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodBoolean>;
+    roles: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    permissions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    avatar: z.ZodOptional<z.ZodString>;
+    locale: z.ZodOptional<z.ZodString>;
+    createTime: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+declare const CreateUserSchema: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    username: z.ZodString;
+    email: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodBoolean>;
+    roles: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    permissions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    avatar: z.ZodOptional<z.ZodString>;
+    locale: z.ZodOptional<z.ZodString>;
+    password: z.ZodString;
+}, z.core.$strip>;
+declare const UpdateUserSchema: z.ZodObject<{
+    id: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
+    username: z.ZodOptional<z.ZodString>;
+    name: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    email: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    status: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
+    roles: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+    permissions: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+    avatar: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    locale: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    createTime: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>;
+declare const PaginatedResponseSchema: <T extends z.ZodType>(itemSchema: T) => z.ZodObject<{
+    data: z.ZodArray<T>;
+    total: z.ZodNumber;
+    page: z.ZodNumber;
+    pageSize: z.ZodNumber;
+    totalPages: z.ZodNumber;
+}, z.core.$strip>;
+declare const ApiResponseSchema: <T extends z.ZodType>(resultSchema: T) => z.ZodObject<{
+    status: z.ZodNumber;
+    message: z.ZodString;
+    result: T;
+    timestamp: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+}, z.core.$strip>;
+declare const ApiErrorResponseSchema: z.ZodObject<{
+    status: z.ZodNumber;
+    code: z.ZodString;
+    message: z.ZodString;
+    result: z.ZodNullable<z.ZodUnknown>;
+    timestamp: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+}, z.core.$strip>;
+declare const TreeNodeSchema: z.ZodType<{
+    id: string;
+    name: string;
+    parentId?: string | null;
+    children?: Array<{
+        id: string;
+        name: string;
+        parentId?: string | null;
+        children?: unknown[];
+    }>;
+}>;
+declare const SelectOptionSchema: z.ZodType<{
+    label: string;
+    value: string | number;
+    disabled?: boolean;
+    children?: Array<{
+        label: string;
+        value: string | number;
+        disabled?: boolean;
+        children?: unknown[];
+    }>;
+}>;
+declare const MenuItemSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    path: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodString>;
+    parentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    sortOrder: z.ZodOptional<z.ZodNumber>;
+    permissions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    children: z.ZodOptional<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+}, z.core.$strip>;
+declare const DictionaryItemSchema: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+    value: z.ZodString;
+    sortOrder: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+declare const UploadFileSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    url: z.ZodString;
+    size: z.ZodNumber;
+    mimeType: z.ZodString;
+    createdAt: z.ZodString;
+}, z.core.$strip>;
+declare const AuthStateSchema: z.ZodObject<{
+    isAuthenticated: z.ZodBoolean;
+    token: z.ZodNullable<z.ZodString>;
+    refreshToken: z.ZodNullable<z.ZodString>;
+    user: z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        username: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        email: z.ZodOptional<z.ZodString>;
+        status: z.ZodOptional<z.ZodBoolean>;
+        roles: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        permissions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        avatar: z.ZodOptional<z.ZodString>;
+        locale: z.ZodOptional<z.ZodString>;
+        createTime: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    permissions: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+declare const LoginRequestSchema: z.ZodObject<{
+    username: z.ZodString;
+    password: z.ZodString;
+    verifyCode: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+declare const LoginResponseSchema: z.ZodObject<{
+    token: z.ZodString;
+    refreshToken: z.ZodOptional<z.ZodString>;
+    user: z.ZodObject<{
+        id: z.ZodString;
+        username: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        email: z.ZodOptional<z.ZodString>;
+        status: z.ZodOptional<z.ZodBoolean>;
+        roles: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        permissions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        avatar: z.ZodOptional<z.ZodString>;
+        locale: z.ZodOptional<z.ZodString>;
+        createTime: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+
+/** Represents an authenticated user in the system. */
+interface User {
+    /** Unique user identifier. */
+    id: string;
+    /** Login username. */
+    username: string;
+    /** Display name. */
+    name?: string;
+    /** Email address. */
+    email?: string;
+    /** Whether the user account is active. */
+    status?: boolean;
+    /** Role codes assigned to the user. */
+    roles?: string[];
+    /** Permission codes granted to the user. */
+    permissions?: string[];
+    /** URL to the user's avatar image. */
+    avatar?: string;
+    /** Preferred locale/language code (e.g. "zh-CN"). */
+    locale?: string;
+    /** ISO timestamp of account creation. */
+    createTime?: string;
+}
+/** Paginated list response envelope. */
+interface PaginatedResponse<T> {
+    /** Items for the current page. */
+    data: T[];
+    /** Total number of items across all pages. */
+    total: number;
+    /** Current page number (1-indexed). */
+    page: number;
+    /** Number of items per page. */
+    pageSize: number;
+    /** Total number of pages. */
+    totalPages: number;
+}
+/** Standard API response envelope wrapping a typed result. */
+interface ApiResponse<T> {
+    /** Business status code (e.g. 200 for success). */
+    status: number;
+    /** Human-readable response message. */
+    message: string;
+    /** The response payload. */
+    result: T;
+    /** ISO timestamp of when the response was generated. */
+    timestamp: string;
+}
+/** Generic tree node used for hierarchical data structures. */
+interface TreeNode {
+    /** Unique node identifier. */
+    id: string;
+    /** Parent node identifier, null for root nodes. */
+    parentId?: string | null;
+    /** Display name of the node. */
+    name: string;
+    /** Child nodes in the hierarchy. */
+    children?: TreeNode[];
+    /** Allow additional domain-specific properties. */
+    [key: string]: unknown;
+}
+/** Option item for select/dropdown components. */
+interface SelectOption {
+    /** Display text shown to the user. */
+    label: string;
+    /** Underlying option value. */
+    value: string | number;
+    /** Whether this option is selectable. */
+    disabled?: boolean;
+    /** Nested child options for cascading selects. */
+    children?: SelectOption[];
+}
+/** Navigation menu item with optional permission gating. */
+interface MenuItem {
+    /** Unique menu item identifier. */
+    id: string;
+    /** Display name of the menu entry. */
+    name: string;
+    /** Route path this menu item links to. */
+    path?: string;
+    /** Icon identifier or component name. */
+    icon?: string;
+    /** Parent menu item identifier, null for top-level items. */
+    parentId?: string | null;
+    /** Numeric sort order for display ordering. */
+    sortOrder?: number;
+    /** Permission codes required to view this menu item. */
+    permissions?: string[];
+    /** Nested child menu items. */
+    children?: MenuItem[];
+}
+/** Metadata for a dictionary/enum entry used in forms and displays. */
+interface DictionaryItem {
+    /** Unique dictionary item identifier. */
+    id: string;
+    /** Human-readable display label. */
+    label: string;
+    /** Machine-readable value. */
+    value: string;
+    /** Numeric sort order for display ordering. */
+    sortOrder?: number;
+}
+/** Metadata for an uploaded file resource. */
+interface UploadFile {
+    /** Unique file identifier. */
+    id: string;
+    /** Original file name. */
+    name: string;
+    /** Accessible URL for the file. */
+    url: string;
+    /** File size in bytes. */
+    size: number;
+    /** MIME type (e.g. "image/png"). */
+    mimeType: string;
+    /** ISO timestamp of when the file was uploaded. */
+    createdAt: string;
+}
+
+/** Shape of the authentication state managed by the auth store. */
+interface AuthState {
+    /** Whether the user is currently authenticated. */
+    isAuthenticated: boolean;
+    /** Current access token, null when not authenticated. */
+    token: string | null;
+    /** Current refresh token, null when not available. */
+    refreshToken: string | null;
+    /** Authenticated user profile, null when not authenticated. */
+    user: User | null;
+    /** Flat list of permission codes granted to the user. */
+    permissions: string[];
+}
+
+export { ApiErrorResponseSchema, type ApiResponse, ApiResponseSchema, type AuthState, AuthStateSchema, CreateUserSchema, type DictionaryItem, DictionaryItemSchema, LoginRequestSchema, LoginResponseSchema, type MenuItem, MenuItemSchema, type PaginatedResponse, PaginatedResponseSchema, type SelectOption, SelectOptionSchema, type TreeNode, TreeNodeSchema, UpdateUserSchema, type UploadFile, UploadFileSchema, type User, UserSchema };

package/dist/index.d.ts

@@ -0,0 +1,294 @@
+import { z } from 'zod/v4';
+
+/**
+ * Zod Schemas — 前后端共享的 Single Source of Truth
+ *
+ * 对标 Claude Code 的 Tool inputSchema/outputSchema 模式：
+ * 一个定义同时提供运行时验证和 TypeScript 类型推断。
+ *
+ * 用法:
+ * ```ts
+ * // 后端 — DTO 验证
+ * const data = UserSchema.parse(req.body);
+ *
+ * // 前端 — 表单验证
+ * const result = UserSchema.safeParse(formValues);
+ *
+ * // 类型推断（无需手动维护 interface）
+ * type User = z.infer<typeof UserSchema>;
+ * ```
+ */
+
+declare const UserSchema: z.ZodObject<{
+    id: z.ZodString;
+    username: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    email: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodBoolean>;
+    roles: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    permissions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    avatar: z.ZodOptional<z.ZodString>;
+    locale: z.ZodOptional<z.ZodString>;
+    createTime: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+declare const CreateUserSchema: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    username: z.ZodString;
+    email: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodBoolean>;
+    roles: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    permissions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    avatar: z.ZodOptional<z.ZodString>;
+    locale: z.ZodOptional<z.ZodString>;
+    password: z.ZodString;
+}, z.core.$strip>;
+declare const UpdateUserSchema: z.ZodObject<{
+    id: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
+    username: z.ZodOptional<z.ZodString>;
+    name: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    email: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    status: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
+    roles: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+    permissions: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+    avatar: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    locale: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    createTime: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>;
+declare const PaginatedResponseSchema: <T extends z.ZodType>(itemSchema: T) => z.ZodObject<{
+    data: z.ZodArray<T>;
+    total: z.ZodNumber;
+    page: z.ZodNumber;
+    pageSize: z.ZodNumber;
+    totalPages: z.ZodNumber;
+}, z.core.$strip>;
+declare const ApiResponseSchema: <T extends z.ZodType>(resultSchema: T) => z.ZodObject<{
+    status: z.ZodNumber;
+    message: z.ZodString;
+    result: T;
+    timestamp: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+}, z.core.$strip>;
+declare const ApiErrorResponseSchema: z.ZodObject<{
+    status: z.ZodNumber;
+    code: z.ZodString;
+    message: z.ZodString;
+    result: z.ZodNullable<z.ZodUnknown>;
+    timestamp: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+}, z.core.$strip>;
+declare const TreeNodeSchema: z.ZodType<{
+    id: string;
+    name: string;
+    parentId?: string | null;
+    children?: Array<{
+        id: string;
+        name: string;
+        parentId?: string | null;
+        children?: unknown[];
+    }>;
+}>;
+declare const SelectOptionSchema: z.ZodType<{
+    label: string;
+    value: string | number;
+    disabled?: boolean;
+    children?: Array<{
+        label: string;
+        value: string | number;
+        disabled?: boolean;
+        children?: unknown[];
+    }>;
+}>;
+declare const MenuItemSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    path: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodString>;
+    parentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    sortOrder: z.ZodOptional<z.ZodNumber>;
+    permissions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    children: z.ZodOptional<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+}, z.core.$strip>;
+declare const DictionaryItemSchema: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+    value: z.ZodString;
+    sortOrder: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+declare const UploadFileSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    url: z.ZodString;
+    size: z.ZodNumber;
+    mimeType: z.ZodString;
+    createdAt: z.ZodString;
+}, z.core.$strip>;
+declare const AuthStateSchema: z.ZodObject<{
+    isAuthenticated: z.ZodBoolean;
+    token: z.ZodNullable<z.ZodString>;
+    refreshToken: z.ZodNullable<z.ZodString>;
+    user: z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        username: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        email: z.ZodOptional<z.ZodString>;
+        status: z.ZodOptional<z.ZodBoolean>;
+        roles: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        permissions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        avatar: z.ZodOptional<z.ZodString>;
+        locale: z.ZodOptional<z.ZodString>;
+        createTime: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    permissions: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+declare const LoginRequestSchema: z.ZodObject<{
+    username: z.ZodString;
+    password: z.ZodString;
+    verifyCode: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+declare const LoginResponseSchema: z.ZodObject<{
+    token: z.ZodString;
+    refreshToken: z.ZodOptional<z.ZodString>;
+    user: z.ZodObject<{
+        id: z.ZodString;
+        username: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        email: z.ZodOptional<z.ZodString>;
+        status: z.ZodOptional<z.ZodBoolean>;
+        roles: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        permissions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        avatar: z.ZodOptional<z.ZodString>;
+        locale: z.ZodOptional<z.ZodString>;
+        createTime: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+
+/** Represents an authenticated user in the system. */
+interface User {
+    /** Unique user identifier. */
+    id: string;
+    /** Login username. */
+    username: string;
+    /** Display name. */
+    name?: string;
+    /** Email address. */
+    email?: string;
+    /** Whether the user account is active. */
+    status?: boolean;
+    /** Role codes assigned to the user. */
+    roles?: string[];
+    /** Permission codes granted to the user. */
+    permissions?: string[];
+    /** URL to the user's avatar image. */
+    avatar?: string;
+    /** Preferred locale/language code (e.g. "zh-CN"). */
+    locale?: string;
+    /** ISO timestamp of account creation. */
+    createTime?: string;
+}
+/** Paginated list response envelope. */
+interface PaginatedResponse<T> {
+    /** Items for the current page. */
+    data: T[];
+    /** Total number of items across all pages. */
+    total: number;
+    /** Current page number (1-indexed). */
+    page: number;
+    /** Number of items per page. */
+    pageSize: number;
+    /** Total number of pages. */
+    totalPages: number;
+}
+/** Standard API response envelope wrapping a typed result. */
+interface ApiResponse<T> {
+    /** Business status code (e.g. 200 for success). */
+    status: number;
+    /** Human-readable response message. */
+    message: string;
+    /** The response payload. */
+    result: T;
+    /** ISO timestamp of when the response was generated. */
+    timestamp: string;
+}
+/** Generic tree node used for hierarchical data structures. */
+interface TreeNode {
+    /** Unique node identifier. */
+    id: string;
+    /** Parent node identifier, null for root nodes. */
+    parentId?: string | null;
+    /** Display name of the node. */
+    name: string;
+    /** Child nodes in the hierarchy. */
+    children?: TreeNode[];
+    /** Allow additional domain-specific properties. */
+    [key: string]: unknown;
+}
+/** Option item for select/dropdown components. */
+interface SelectOption {
+    /** Display text shown to the user. */
+    label: string;
+    /** Underlying option value. */
+    value: string | number;
+    /** Whether this option is selectable. */
+    disabled?: boolean;
+    /** Nested child options for cascading selects. */
+    children?: SelectOption[];
+}
+/** Navigation menu item with optional permission gating. */
+interface MenuItem {
+    /** Unique menu item identifier. */
+    id: string;
+    /** Display name of the menu entry. */
+    name: string;
+    /** Route path this menu item links to. */
+    path?: string;
+    /** Icon identifier or component name. */
+    icon?: string;
+    /** Parent menu item identifier, null for top-level items. */
+    parentId?: string | null;
+    /** Numeric sort order for display ordering. */
+    sortOrder?: number;
+    /** Permission codes required to view this menu item. */
+    permissions?: string[];
+    /** Nested child menu items. */
+    children?: MenuItem[];
+}
+/** Metadata for a dictionary/enum entry used in forms and displays. */
+interface DictionaryItem {
+    /** Unique dictionary item identifier. */
+    id: string;
+    /** Human-readable display label. */
+    label: string;
+    /** Machine-readable value. */
+    value: string;
+    /** Numeric sort order for display ordering. */
+    sortOrder?: number;
+}
+/** Metadata for an uploaded file resource. */
+interface UploadFile {
+    /** Unique file identifier. */
+    id: string;
+    /** Original file name. */
+    name: string;
+    /** Accessible URL for the file. */
+    url: string;
+    /** File size in bytes. */
+    size: number;
+    /** MIME type (e.g. "image/png"). */
+    mimeType: string;
+    /** ISO timestamp of when the file was uploaded. */
+    createdAt: string;
+}
+
+/** Shape of the authentication state managed by the auth store. */
+interface AuthState {
+    /** Whether the user is currently authenticated. */
+    isAuthenticated: boolean;
+    /** Current access token, null when not authenticated. */
+    token: string | null;
+    /** Current refresh token, null when not available. */
+    refreshToken: string | null;
+    /** Authenticated user profile, null when not authenticated. */
+    user: User | null;
+    /** Flat list of permission codes granted to the user. */
+    permissions: string[];
+}
+
+export { ApiErrorResponseSchema, type ApiResponse, ApiResponseSchema, type AuthState, AuthStateSchema, CreateUserSchema, type DictionaryItem, DictionaryItemSchema, LoginRequestSchema, LoginResponseSchema, type MenuItem, MenuItemSchema, type PaginatedResponse, PaginatedResponseSchema, type SelectOption, SelectOptionSchema, type TreeNode, TreeNodeSchema, UpdateUserSchema, type UploadFile, UploadFileSchema, type User, UserSchema };

package/dist/index.js

@@ -0,0 +1,147 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  ApiErrorResponseSchema: () => ApiErrorResponseSchema,
+  ApiResponseSchema: () => ApiResponseSchema,
+  AuthStateSchema: () => AuthStateSchema,
+  CreateUserSchema: () => CreateUserSchema,
+  DictionaryItemSchema: () => DictionaryItemSchema,
+  LoginRequestSchema: () => LoginRequestSchema,
+  LoginResponseSchema: () => LoginResponseSchema,
+  MenuItemSchema: () => MenuItemSchema,
+  PaginatedResponseSchema: () => PaginatedResponseSchema,
+  SelectOptionSchema: () => SelectOptionSchema,
+  TreeNodeSchema: () => TreeNodeSchema,
+  UpdateUserSchema: () => UpdateUserSchema,
+  UploadFileSchema: () => UploadFileSchema,
+  UserSchema: () => UserSchema
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/schemas.ts
+var import_v4 = require("zod/v4");
+var UserSchema = import_v4.z.object({
+  id: import_v4.z.string(),
+  username: import_v4.z.string().min(2).max(32),
+  name: import_v4.z.string().optional(),
+  email: import_v4.z.string().email().optional(),
+  status: import_v4.z.boolean().optional(),
+  roles: import_v4.z.array(import_v4.z.string()).optional(),
+  permissions: import_v4.z.array(import_v4.z.string()).optional(),
+  avatar: import_v4.z.string().url().optional(),
+  locale: import_v4.z.string().optional(),
+  createTime: import_v4.z.string().optional()
+});
+var CreateUserSchema = UserSchema.omit({ id: true, createTime: true }).extend({
+  password: import_v4.z.string().min(6).max(128)
+});
+var UpdateUserSchema = UserSchema.partial().required({ id: true });
+var PaginatedResponseSchema = (itemSchema) => import_v4.z.object({
+  data: import_v4.z.array(itemSchema),
+  total: import_v4.z.number().int().min(0),
+  page: import_v4.z.number().int().min(1),
+  pageSize: import_v4.z.number().int().min(1),
+  totalPages: import_v4.z.number().int().min(0)
+});
+var ApiResponseSchema = (resultSchema) => import_v4.z.object({
+  status: import_v4.z.number().int(),
+  message: import_v4.z.string(),
+  result: resultSchema,
+  timestamp: import_v4.z.union([import_v4.z.string(), import_v4.z.number()])
+});
+var ApiErrorResponseSchema = import_v4.z.object({
+  status: import_v4.z.number().int(),
+  code: import_v4.z.string(),
+  message: import_v4.z.string(),
+  result: import_v4.z.unknown().nullable(),
+  timestamp: import_v4.z.union([import_v4.z.string(), import_v4.z.number()])
+});
+var TreeNodeSchema = import_v4.z.object({
+  id: import_v4.z.string(),
+  name: import_v4.z.string(),
+  parentId: import_v4.z.string().nullable().optional(),
+  children: import_v4.z.lazy(() => import_v4.z.array(TreeNodeSchema)).optional()
+});
+var SelectOptionSchema = import_v4.z.object({
+  label: import_v4.z.string(),
+  value: import_v4.z.union([import_v4.z.string(), import_v4.z.number()]),
+  disabled: import_v4.z.boolean().optional(),
+  children: import_v4.z.lazy(() => import_v4.z.array(SelectOptionSchema)).optional()
+});
+var MenuItemSchema = import_v4.z.object({
+  id: import_v4.z.string(),
+  name: import_v4.z.string(),
+  path: import_v4.z.string().optional(),
+  icon: import_v4.z.string().optional(),
+  parentId: import_v4.z.string().nullable().optional(),
+  sortOrder: import_v4.z.number().int().optional(),
+  permissions: import_v4.z.array(import_v4.z.string()).optional(),
+  children: import_v4.z.lazy(() => import_v4.z.array(MenuItemSchema)).optional()
+});
+var DictionaryItemSchema = import_v4.z.object({
+  id: import_v4.z.string(),
+  label: import_v4.z.string(),
+  value: import_v4.z.string(),
+  sortOrder: import_v4.z.number().int().optional()
+});
+var UploadFileSchema = import_v4.z.object({
+  id: import_v4.z.string(),
+  name: import_v4.z.string(),
+  url: import_v4.z.string().url(),
+  size: import_v4.z.number().int().min(0),
+  mimeType: import_v4.z.string(),
+  createdAt: import_v4.z.string()
+});
+var AuthStateSchema = import_v4.z.object({
+  isAuthenticated: import_v4.z.boolean(),
+  token: import_v4.z.string().nullable(),
+  refreshToken: import_v4.z.string().nullable(),
+  user: UserSchema.nullable(),
+  permissions: import_v4.z.array(import_v4.z.string())
+});
+var LoginRequestSchema = import_v4.z.object({
+  username: import_v4.z.string().min(1),
+  password: import_v4.z.string().min(1),
+  verifyCode: import_v4.z.string().optional()
+});
+var LoginResponseSchema = import_v4.z.object({
+  token: import_v4.z.string(),
+  refreshToken: import_v4.z.string().optional(),
+  user: UserSchema
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ApiErrorResponseSchema,
+  ApiResponseSchema,
+  AuthStateSchema,
+  CreateUserSchema,
+  DictionaryItemSchema,
+  LoginRequestSchema,
+  LoginResponseSchema,
+  MenuItemSchema,
+  PaginatedResponseSchema,
+  SelectOptionSchema,
+  TreeNodeSchema,
+  UpdateUserSchema,
+  UploadFileSchema,
+  UserSchema
+});

package/dist/index.mjs

@@ -0,0 +1,107 @@
+// src/schemas.ts
+import { z } from "zod/v4";
+var UserSchema = z.object({
+  id: z.string(),
+  username: z.string().min(2).max(32),
+  name: z.string().optional(),
+  email: z.string().email().optional(),
+  status: z.boolean().optional(),
+  roles: z.array(z.string()).optional(),
+  permissions: z.array(z.string()).optional(),
+  avatar: z.string().url().optional(),
+  locale: z.string().optional(),
+  createTime: z.string().optional()
+});
+var CreateUserSchema = UserSchema.omit({ id: true, createTime: true }).extend({
+  password: z.string().min(6).max(128)
+});
+var UpdateUserSchema = UserSchema.partial().required({ id: true });
+var PaginatedResponseSchema = (itemSchema) => z.object({
+  data: z.array(itemSchema),
+  total: z.number().int().min(0),
+  page: z.number().int().min(1),
+  pageSize: z.number().int().min(1),
+  totalPages: z.number().int().min(0)
+});
+var ApiResponseSchema = (resultSchema) => z.object({
+  status: z.number().int(),
+  message: z.string(),
+  result: resultSchema,
+  timestamp: z.union([z.string(), z.number()])
+});
+var ApiErrorResponseSchema = z.object({
+  status: z.number().int(),
+  code: z.string(),
+  message: z.string(),
+  result: z.unknown().nullable(),
+  timestamp: z.union([z.string(), z.number()])
+});
+var TreeNodeSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  parentId: z.string().nullable().optional(),
+  children: z.lazy(() => z.array(TreeNodeSchema)).optional()
+});
+var SelectOptionSchema = z.object({
+  label: z.string(),
+  value: z.union([z.string(), z.number()]),
+  disabled: z.boolean().optional(),
+  children: z.lazy(() => z.array(SelectOptionSchema)).optional()
+});
+var MenuItemSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  path: z.string().optional(),
+  icon: z.string().optional(),
+  parentId: z.string().nullable().optional(),
+  sortOrder: z.number().int().optional(),
+  permissions: z.array(z.string()).optional(),
+  children: z.lazy(() => z.array(MenuItemSchema)).optional()
+});
+var DictionaryItemSchema = z.object({
+  id: z.string(),
+  label: z.string(),
+  value: z.string(),
+  sortOrder: z.number().int().optional()
+});
+var UploadFileSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  url: z.string().url(),
+  size: z.number().int().min(0),
+  mimeType: z.string(),
+  createdAt: z.string()
+});
+var AuthStateSchema = z.object({
+  isAuthenticated: z.boolean(),
+  token: z.string().nullable(),
+  refreshToken: z.string().nullable(),
+  user: UserSchema.nullable(),
+  permissions: z.array(z.string())
+});
+var LoginRequestSchema = z.object({
+  username: z.string().min(1),
+  password: z.string().min(1),
+  verifyCode: z.string().optional()
+});
+var LoginResponseSchema = z.object({
+  token: z.string(),
+  refreshToken: z.string().optional(),
+  user: UserSchema
+});
+export {
+  ApiErrorResponseSchema,
+  ApiResponseSchema,
+  AuthStateSchema,
+  CreateUserSchema,
+  DictionaryItemSchema,
+  LoginRequestSchema,
+  LoginResponseSchema,
+  MenuItemSchema,
+  PaginatedResponseSchema,
+  SelectOptionSchema,
+  TreeNodeSchema,
+  UpdateUserSchema,
+  UploadFileSchema,
+  UserSchema
+};

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@zucker-framework/fe-types",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "LICENSE",
+    "NOTICE",
+    "THIRD_PARTY_NOTICES"
+  ],
+  "dependencies": {
+    "zod": "^4.5.4"
+  },
+  "license": "Apache-2.0",
+  "author": "Lind",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Lind-pro/zucker-framework.git",
+    "directory": "packages/fe-types"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "clean": "rm -rf dist"
+  }
+}