openxiangda 1.0.18 → 1.0.20

package/packages/sdk/dist/runtime/index.d.mts

@@ -127,6 +127,13 @@ interface PageDataSourceDescriptor {
     defaultFilter?: SearchExpression | string;
     [key: string]: unknown;
 }
+type CustomPageEntryMode = "app-shell" | "plain-page";
+interface CustomPageEntryConfig {
+    mode?: CustomPageEntryMode | string;
+    hidePlatformNav?: boolean;
+    defaultRoute?: string;
+    [key: string]: unknown;
+}
 interface PageInfo {
     id: string;
     code: string;
@@ -138,6 +145,7 @@ interface PageInfo {
     status: string;
     props: Record<string, unknown>;
     route: Record<string, unknown> | object;
+    entry?: CustomPageEntryConfig;
     dataSources: PageDataSourceDescriptor[];
     capabilities: Record<string, unknown>;
     version?: string;
@@ -164,6 +172,8 @@ interface PageNavigationApi {
      */
     pushPage(pageKey: string, query?: Record<string, unknown>): void;
     replacePage(pageKey: string, query?: Record<string, unknown>): void;
+    pushRoute(route: string, query?: Record<string, unknown>): void;
+    replaceRoute(route: string, query?: Record<string, unknown>): void;
     updateQuery(query: Record<string, unknown>): void;
     setHash(hash: string): void;
     back(): void;
@@ -856,4 +866,4 @@ declare const usePageRoute: () => PageRouteInfo;
 
 declare const usePageSdk: () => PageSdk;
 
-export { type ApiPermissionListParams, type ApproveTaskParams, type AssignPermissionsParams, type AssignRolesParams, type BatchAddUsersToRoleParams, type BatchSendNotificationByTypeParams, type ChangeUserRoleParams, type ConnectorCallParams, type ConnectorInvokeParams, type ConnectorInvokeResult, type ConnectorRequestBodyType, type ConnectorResponseType, type CreateApiPermissionParams, type CreateFormPermissionGroupDto, type CreatePagePermissionGroupDto, type CreateRoleParams, type CreateUiPermissionParams, type CreateUserParams, type CurrentUserDepartmentParents, type DataManagementConfigParams, type DataManagementFilterState, type DataPermissionConditionDto, type DataPermissionDto, type DataPermissionRuleDto, type FieldPermissionDto, type FormAdvancedSearchParams, type FormChangeRecordParams, type FormCreateParams, type FormExportParams, type FormGetDetailParams, type FormImportParams, type FormPermissionGroup, type FormRemoveParams, type FormSearchParams, type FormUpdateParams, type GetParentDepartmentsOptions, type GetProcessInstanceParams, type GetUserRolesParams, type ImportExportRecordDownloadParams, type ImportExportRecordQuery, type InstanceStatus, type NotificationChannel, type NotificationMessageRecord, type PageApiPermissionRecord, type PageApiResponse, type PageAppInfo, type PageBinaryResponse, type PageBridgeApi, type PageContext, type PageDataManagementConfig, type PageDataSourceDescriptor, type PageDepartmentInfo, type PageDepartmentRecord, type PageHttpMethod, type PageInfo, type PageListResult, type PageMessageApi, type PageModalApi, type PageNavigationApi, type PageOffsetListResult, type PagePermissionGroup, type PagePermissionInfo, PageProvider, type PageQueryValue, type PageRequestOptions, type PageRoleRecord, type PageRouteInfo, type PageScope, type PageSdk, type PageSdkError, type PageSdkMeta, type PageTransportDownloadPayload, type PageTransportRequestPayload, type PageUiPermissionRecord, type PageUiPermissionType, type PageUserInfo, type PageUserRecord, type PageUserType, type ProcessApproveAction, type QueryFormPermissionGroupDto, type QueryPagePermissionGroupDto, type RoleListParams, type RoleUsersParams, type SaveDataManagementConfigParams, type SearchComponentName, type SearchExpression, type SearchFieldKey, type SearchGroup, type SearchLogic, type SearchOperator, type SearchRule, type SearchSortItem, type SearchSystemField, type SendNotificationByTypeParams, type SendNotificationResult, type SubFormRule, type SwitchAppRoleParams, type SwitchPlatformRoleParams, type TerminateProcessInstanceParams, type TriggerCallbackTaskParams, type UiPermissionListParams, type UpdateApiPermissionParams, type UpdateFormPermissionGroupDto, type UpdatePagePermissionGroupDto, type UpdateRoleParams, type UpdateUiPermissionParams, type UpdateUserParams, type UserListParams, type UserMenuPermissionsResponse, type ValidateUserParams, type ViewFieldPermissionValue, type ViewOperationPermission, type ViewPermissionSummary, createPageSdk, createReactPage, useCurrentUser, useDataSource, useFormViewPermissions, useMessage, useModal, useNavigation, usePageContext, usePageProps, usePageRoute, usePageSdk };
+export { type ApiPermissionListParams, type ApproveTaskParams, type AssignPermissionsParams, type AssignRolesParams, type BatchAddUsersToRoleParams, type BatchSendNotificationByTypeParams, type ChangeUserRoleParams, type ConnectorCallParams, type ConnectorInvokeParams, type ConnectorInvokeResult, type ConnectorRequestBodyType, type ConnectorResponseType, type CreateApiPermissionParams, type CreateFormPermissionGroupDto, type CreatePagePermissionGroupDto, type CreateRoleParams, type CreateUiPermissionParams, type CreateUserParams, type CurrentUserDepartmentParents, type CustomPageEntryConfig, type CustomPageEntryMode, type DataManagementConfigParams, type DataManagementFilterState, type DataPermissionConditionDto, type DataPermissionDto, type DataPermissionRuleDto, type FieldPermissionDto, type FormAdvancedSearchParams, type FormChangeRecordParams, type FormCreateParams, type FormExportParams, type FormGetDetailParams, type FormImportParams, type FormPermissionGroup, type FormRemoveParams, type FormSearchParams, type FormUpdateParams, type GetParentDepartmentsOptions, type GetProcessInstanceParams, type GetUserRolesParams, type ImportExportRecordDownloadParams, type ImportExportRecordQuery, type InstanceStatus, type NotificationChannel, type NotificationMessageRecord, type PageApiPermissionRecord, type PageApiResponse, type PageAppInfo, type PageBinaryResponse, type PageBridgeApi, type PageContext, type PageDataManagementConfig, type PageDataSourceDescriptor, type PageDepartmentInfo, type PageDepartmentRecord, type PageHttpMethod, type PageInfo, type PageListResult, type PageMessageApi, type PageModalApi, type PageNavigationApi, type PageOffsetListResult, type PagePermissionGroup, type PagePermissionInfo, PageProvider, type PageQueryValue, type PageRequestOptions, type PageRoleRecord, type PageRouteInfo, type PageScope, type PageSdk, type PageSdkError, type PageSdkMeta, type PageTransportDownloadPayload, type PageTransportRequestPayload, type PageUiPermissionRecord, type PageUiPermissionType, type PageUserInfo, type PageUserRecord, type PageUserType, type ProcessApproveAction, type QueryFormPermissionGroupDto, type QueryPagePermissionGroupDto, type RoleListParams, type RoleUsersParams, type SaveDataManagementConfigParams, type SearchComponentName, type SearchExpression, type SearchFieldKey, type SearchGroup, type SearchLogic, type SearchOperator, type SearchRule, type SearchSortItem, type SearchSystemField, type SendNotificationByTypeParams, type SendNotificationResult, type SubFormRule, type SwitchAppRoleParams, type SwitchPlatformRoleParams, type TerminateProcessInstanceParams, type TriggerCallbackTaskParams, type UiPermissionListParams, type UpdateApiPermissionParams, type UpdateFormPermissionGroupDto, type UpdatePagePermissionGroupDto, type UpdateRoleParams, type UpdateUiPermissionParams, type UpdateUserParams, type UserListParams, type UserMenuPermissionsResponse, type ValidateUserParams, type ViewFieldPermissionValue, type ViewOperationPermission, type ViewPermissionSummary, createPageSdk, createReactPage, useCurrentUser, useDataSource, useFormViewPermissions, useMessage, useModal, useNavigation, usePageContext, usePageProps, usePageRoute, usePageSdk };

package/packages/sdk/dist/runtime/index.d.ts

@@ -127,6 +127,13 @@ interface PageDataSourceDescriptor {
     defaultFilter?: SearchExpression | string;
     [key: string]: unknown;
 }
+type CustomPageEntryMode = "app-shell" | "plain-page";
+interface CustomPageEntryConfig {
+    mode?: CustomPageEntryMode | string;
+    hidePlatformNav?: boolean;
+    defaultRoute?: string;
+    [key: string]: unknown;
+}
 interface PageInfo {
     id: string;
     code: string;
@@ -138,6 +145,7 @@ interface PageInfo {
     status: string;
     props: Record<string, unknown>;
     route: Record<string, unknown> | object;
+    entry?: CustomPageEntryConfig;
     dataSources: PageDataSourceDescriptor[];
     capabilities: Record<string, unknown>;
     version?: string;
@@ -164,6 +172,8 @@ interface PageNavigationApi {
      */
     pushPage(pageKey: string, query?: Record<string, unknown>): void;
     replacePage(pageKey: string, query?: Record<string, unknown>): void;
+    pushRoute(route: string, query?: Record<string, unknown>): void;
+    replaceRoute(route: string, query?: Record<string, unknown>): void;
     updateQuery(query: Record<string, unknown>): void;
     setHash(hash: string): void;
     back(): void;
@@ -856,4 +866,4 @@ declare const usePageRoute: () => PageRouteInfo;
 
 declare const usePageSdk: () => PageSdk;
 
-export { type ApiPermissionListParams, type ApproveTaskParams, type AssignPermissionsParams, type AssignRolesParams, type BatchAddUsersToRoleParams, type BatchSendNotificationByTypeParams, type ChangeUserRoleParams, type ConnectorCallParams, type ConnectorInvokeParams, type ConnectorInvokeResult, type ConnectorRequestBodyType, type ConnectorResponseType, type CreateApiPermissionParams, type CreateFormPermissionGroupDto, type CreatePagePermissionGroupDto, type CreateRoleParams, type CreateUiPermissionParams, type CreateUserParams, type CurrentUserDepartmentParents, type DataManagementConfigParams, type DataManagementFilterState, type DataPermissionConditionDto, type DataPermissionDto, type DataPermissionRuleDto, type FieldPermissionDto, type FormAdvancedSearchParams, type FormChangeRecordParams, type FormCreateParams, type FormExportParams, type FormGetDetailParams, type FormImportParams, type FormPermissionGroup, type FormRemoveParams, type FormSearchParams, type FormUpdateParams, type GetParentDepartmentsOptions, type GetProcessInstanceParams, type GetUserRolesParams, type ImportExportRecordDownloadParams, type ImportExportRecordQuery, type InstanceStatus, type NotificationChannel, type NotificationMessageRecord, type PageApiPermissionRecord, type PageApiResponse, type PageAppInfo, type PageBinaryResponse, type PageBridgeApi, type PageContext, type PageDataManagementConfig, type PageDataSourceDescriptor, type PageDepartmentInfo, type PageDepartmentRecord, type PageHttpMethod, type PageInfo, type PageListResult, type PageMessageApi, type PageModalApi, type PageNavigationApi, type PageOffsetListResult, type PagePermissionGroup, type PagePermissionInfo, PageProvider, type PageQueryValue, type PageRequestOptions, type PageRoleRecord, type PageRouteInfo, type PageScope, type PageSdk, type PageSdkError, type PageSdkMeta, type PageTransportDownloadPayload, type PageTransportRequestPayload, type PageUiPermissionRecord, type PageUiPermissionType, type PageUserInfo, type PageUserRecord, type PageUserType, type ProcessApproveAction, type QueryFormPermissionGroupDto, type QueryPagePermissionGroupDto, type RoleListParams, type RoleUsersParams, type SaveDataManagementConfigParams, type SearchComponentName, type SearchExpression, type SearchFieldKey, type SearchGroup, type SearchLogic, type SearchOperator, type SearchRule, type SearchSortItem, type SearchSystemField, type SendNotificationByTypeParams, type SendNotificationResult, type SubFormRule, type SwitchAppRoleParams, type SwitchPlatformRoleParams, type TerminateProcessInstanceParams, type TriggerCallbackTaskParams, type UiPermissionListParams, type UpdateApiPermissionParams, type UpdateFormPermissionGroupDto, type UpdatePagePermissionGroupDto, type UpdateRoleParams, type UpdateUiPermissionParams, type UpdateUserParams, type UserListParams, type UserMenuPermissionsResponse, type ValidateUserParams, type ViewFieldPermissionValue, type ViewOperationPermission, type ViewPermissionSummary, createPageSdk, createReactPage, useCurrentUser, useDataSource, useFormViewPermissions, useMessage, useModal, useNavigation, usePageContext, usePageProps, usePageRoute, usePageSdk };
+export { type ApiPermissionListParams, type ApproveTaskParams, type AssignPermissionsParams, type AssignRolesParams, type BatchAddUsersToRoleParams, type BatchSendNotificationByTypeParams, type ChangeUserRoleParams, type ConnectorCallParams, type ConnectorInvokeParams, type ConnectorInvokeResult, type ConnectorRequestBodyType, type ConnectorResponseType, type CreateApiPermissionParams, type CreateFormPermissionGroupDto, type CreatePagePermissionGroupDto, type CreateRoleParams, type CreateUiPermissionParams, type CreateUserParams, type CurrentUserDepartmentParents, type CustomPageEntryConfig, type CustomPageEntryMode, type DataManagementConfigParams, type DataManagementFilterState, type DataPermissionConditionDto, type DataPermissionDto, type DataPermissionRuleDto, type FieldPermissionDto, type FormAdvancedSearchParams, type FormChangeRecordParams, type FormCreateParams, type FormExportParams, type FormGetDetailParams, type FormImportParams, type FormPermissionGroup, type FormRemoveParams, type FormSearchParams, type FormUpdateParams, type GetParentDepartmentsOptions, type GetProcessInstanceParams, type GetUserRolesParams, type ImportExportRecordDownloadParams, type ImportExportRecordQuery, type InstanceStatus, type NotificationChannel, type NotificationMessageRecord, type PageApiPermissionRecord, type PageApiResponse, type PageAppInfo, type PageBinaryResponse, type PageBridgeApi, type PageContext, type PageDataManagementConfig, type PageDataSourceDescriptor, type PageDepartmentInfo, type PageDepartmentRecord, type PageHttpMethod, type PageInfo, type PageListResult, type PageMessageApi, type PageModalApi, type PageNavigationApi, type PageOffsetListResult, type PagePermissionGroup, type PagePermissionInfo, PageProvider, type PageQueryValue, type PageRequestOptions, type PageRoleRecord, type PageRouteInfo, type PageScope, type PageSdk, type PageSdkError, type PageSdkMeta, type PageTransportDownloadPayload, type PageTransportRequestPayload, type PageUiPermissionRecord, type PageUiPermissionType, type PageUserInfo, type PageUserRecord, type PageUserType, type ProcessApproveAction, type QueryFormPermissionGroupDto, type QueryPagePermissionGroupDto, type RoleListParams, type RoleUsersParams, type SaveDataManagementConfigParams, type SearchComponentName, type SearchExpression, type SearchFieldKey, type SearchGroup, type SearchLogic, type SearchOperator, type SearchRule, type SearchSortItem, type SearchSystemField, type SendNotificationByTypeParams, type SendNotificationResult, type SubFormRule, type SwitchAppRoleParams, type SwitchPlatformRoleParams, type TerminateProcessInstanceParams, type TriggerCallbackTaskParams, type UiPermissionListParams, type UpdateApiPermissionParams, type UpdateFormPermissionGroupDto, type UpdatePagePermissionGroupDto, type UpdateRoleParams, type UpdateUiPermissionParams, type UpdateUserParams, type UserListParams, type UserMenuPermissionsResponse, type ValidateUserParams, type ViewFieldPermissionValue, type ViewOperationPermission, type ViewPermissionSummary, createPageSdk, createReactPage, useCurrentUser, useDataSource, useFormViewPermissions, useMessage, useModal, useNavigation, usePageContext, usePageProps, usePageRoute, usePageSdk };

package/packages/sdk/src/build-source/scripts/utils/register-payload.mjs

@@ -66,6 +66,7 @@ export function buildDirectPagePublishPayload(config, pages) {
         code: page.config.code,
         name: page.config.name,
         description: page.config.description || "",
+        entry: page.config.entry || {},
         route: page.config.route,
         props: page.config.props || {},
         dataSources: page.config.dataSources || [],

package/packages/sdk/src/build-source/scripts/utils/register-payload.test.ts

@@ -1,7 +1,9 @@
-import { describe, expect, it } from "vitest";
+import { mkdtemp, mkdir, rm, writeFile } from "node:fs/promises";
+import { join } from "node:path";
+
+import { describe, expect, it, vi } from "vitest";
 
 import { getFormBundleUrl, getPageAssetUrl } from "./load-config.mjs";
-import { discoverPages } from "./pages.mjs";
 import { buildDirectPagePublishPayload } from "./register-payload.mjs";
 
 const config = {
@@ -25,10 +27,47 @@ const config = {
 
 describe("register payload helpers", () => {
   it("discovers publishable code pages", async () => {
-    const pages = await discoverPages("customer-dashboard");
+    const workspaceRoot = await mkdtemp(
+      join(process.cwd(), ".tmp-openxiangda-pages-test-"),
+    );
+    const previousWorkspaceRoot = process.env.LOWCODE_WORKSPACE_ROOT;
+
+    try {
+      const pageDir = join(workspaceRoot, "src/pages/customer-dashboard");
+      await mkdir(pageDir, { recursive: true });
+      await writeFile(join(pageDir, "index.tsx"), "export {};\n", "utf8");
+      await writeFile(
+        join(pageDir, "App.tsx"),
+        "export default function App() { return null; }\n",
+        "utf8",
+      );
+      await writeFile(
+        join(pageDir, "page.config.ts"),
+        `export default {
+  code: "customer-dashboard",
+  name: "客户经营看板",
+  route: { pathKey: "customer-dashboard" },
+};
+`,
+        "utf8",
+      );
+
+      process.env.LOWCODE_WORKSPACE_ROOT = workspaceRoot;
+      vi.resetModules();
+      const { discoverPages } = await import("./pages.mjs");
+      const pages = await discoverPages("customer-dashboard");
 
-    expect(pages).toHaveLength(1);
-    expect(pages[0].config.code).toBe("customer-dashboard");
+      expect(pages).toHaveLength(1);
+      expect(pages[0].config.code).toBe("customer-dashboard");
+    } finally {
+      if (previousWorkspaceRoot === undefined) {
+        delete process.env.LOWCODE_WORKSPACE_ROOT;
+      } else {
+        process.env.LOWCODE_WORKSPACE_ROOT = previousWorkspaceRoot;
+      }
+      vi.resetModules();
+      await rm(workspaceRoot, { recursive: true, force: true });
+    }
   });
 
   it("builds stable form and page asset URLs from one build id", () => {
@@ -46,6 +85,11 @@ describe("register payload helpers", () => {
         config: {
           code: "customer-dashboard",
           name: "客户经营看板",
+          entry: {
+            mode: "app-shell",
+            hidePlatformNav: true,
+            defaultRoute: "home",
+          },
           route: { pathKey: "customer-dashboard" },
           props: { title: "客户经营看板" },
           dataSources: [],
@@ -56,6 +100,11 @@ describe("register payload helpers", () => {
     expect(payload.pages[0].runtime.entryUrl).toBe(
       "https://bucket.oss-cn-hangzhou.aliyuncs.com/lowcode/app-workspace/dev/1.2.3/BUILD_001/pages/customer-dashboard/index.js",
     );
+    expect(payload.pages[0].entry).toEqual({
+      mode: "app-shell",
+      hidePlatformNav: true,
+      defaultRoute: "home",
+    });
     expect(JSON.stringify(payload)).not.toMatch(/manifest/i);
   });
 

package/templates/sy-lowcode-app-workspace/src/types/app-workspace.types.ts

@@ -26,6 +26,42 @@ export interface AppWorkspaceConfig {
   };
 }
 
+export type CustomPageEntryMode = "app-shell" | "plain-page";
+
+export interface CustomPageEntryConfig {
+  mode?: CustomPageEntryMode | string;
+  hidePlatformNav?: boolean;
+  defaultRoute?: string;
+}
+
+export interface CustomPageConfig {
+  code: string;
+  name: string;
+  description?: string;
+  publish?: boolean;
+  route?: {
+    pathKey?: string;
+    allowQueryKeys?: string[];
+    allowHash?: boolean;
+    subRouteMode?: "hash" | "memory" | string;
+    defaultQuery?: Record<string, unknown>;
+  };
+  entry?: CustomPageEntryConfig;
+  props?: Record<string, unknown>;
+  dataSources?: Array<Record<string, unknown>>;
+  menu?: {
+    enabled?: boolean;
+    name?: string;
+    parentId?: string | null;
+    icon?: string | null;
+  };
+  cssIsolation?: "namespace" | "shadow" | "none";
+}
+
 export function defineAppWorkspaceConfig<T extends AppWorkspaceConfig>(config: T): T {
   return config;
 }
+
+export function definePageConfig<T extends CustomPageConfig>(config: T): T {
+  return config;
+}