sy-page-sdk 0.1.0

package/dist/react/index.d.cts

@@ -0,0 +1,77 @@
+import React, { Dispatch, SetStateAction } from 'react';
+import { PageContext, PageUserInfo, PageUserType, PageApiResponse, ViewPermissionSummary, ViewOperationPermission, ViewFieldPermissionValue, PageMessageApi, PageModalApi, PageNavigationApi, PageRouteInfo, PageSdk } from '../index.cjs';
+export { ApiPermissionListParams, ApproveTaskParams, AssignPermissionsParams, AssignRolesParams, BatchAddUsersToRoleParams, BatchSendNotificationByTypeParams, ChangeUserRoleParams, CreateApiPermissionParams, CreateFormPermissionGroupDto, CreatePagePermissionGroupDto, CreateRoleParams, CreateUiPermissionParams, CreateUserParams, DataManagementConfigParams, DataManagementFilterState, DataPermissionConditionDto, DataPermissionDto, DataPermissionRuleDto, FieldPermissionDto, FormAdvancedSearchParams, FormChangeRecordParams, FormCreateParams, FormExportParams, FormGetDetailParams, FormImportParams, FormPermissionGroup, FormRemoveParams, FormSearchParams, FormUpdateParams, GetProcessInstanceParams, GetUserRolesParams, ImportExportRecordDownloadParams, ImportExportRecordQuery, InstanceStatus, NotificationChannel, NotificationMessageRecord, PageApiPermissionRecord, PageAppInfo, PageBinaryResponse, PageBridgeApi, PageDataManagementConfig, PageDataSourceDescriptor, PageDepartmentInfo, PageHttpMethod, PageInfo, PageListResult, PageOffsetListResult, PagePermissionGroup, PagePermissionInfo, PageQueryValue, PageRequestOptions, PageRoleRecord, PageScope, PageSdkError, PageSdkMeta, PageTransportDownloadPayload, PageTransportRequestPayload, PageUiPermissionRecord, PageUiPermissionType, PageUserRecord, ProcessApproveAction, QueryFormPermissionGroupDto, QueryPagePermissionGroupDto, RoleListParams, RoleUsersParams, SaveDataManagementConfigParams, SearchComponentName, SearchExpression, SearchFieldKey, SearchGroup, SearchLogic, SearchOperator, SearchRule, SearchSortItem, SearchSystemField, SendNotificationByTypeParams, SendNotificationResult, SubFormRule, SwitchAppRoleParams, SwitchPlatformRoleParams, TerminateProcessInstanceParams, TriggerCallbackTaskParams, UiPermissionListParams, UpdateApiPermissionParams, UpdateFormPermissionGroupDto, UpdatePagePermissionGroupDto, UpdateRoleParams, UpdateUiPermissionParams, UpdateUserParams, UserListParams, UserMenuPermissionsResponse, ValidateUserParams, createPageSdk } from '../index.cjs';
+
+declare const createReactPage: (AppComponent: React.ComponentType) => {
+    mount: (el: HTMLElement, context: PageContext) => void;
+    update: (el: HTMLElement, context: PageContext) => void;
+    unmount: () => void;
+};
+
+interface PageProviderProps {
+    context: PageContext;
+    children: React.ReactNode;
+}
+declare const PageProvider: React.FC<PageProviderProps>;
+
+interface CurrentUserState {
+    user: PageUserInfo & {
+        userType: PageUserType;
+        isGuest: boolean;
+    };
+    isGuest: boolean;
+    isInternalUser: boolean;
+    displayName: string;
+    primaryDepartment: NonNullable<PageUserInfo["departments"]>[number] | null;
+}
+declare const useCurrentUser: () => CurrentUserState;
+
+interface UseDataSourceOptions<TResult = unknown, TData = TResult, TParams extends Record<string, unknown> = Record<string, unknown>> {
+    params?: TParams;
+    immediate?: boolean;
+    transform?: (result: TResult, response: PageApiResponse<TResult>) => TData;
+}
+interface UseDataSourceResult<TResult = unknown, TData = TResult, TParams extends Record<string, unknown> = Record<string, unknown>> {
+    response: PageApiResponse<TResult> | null;
+    result: TResult | null;
+    data: TData | null;
+    loading: boolean;
+    error: Error | null;
+    refresh: (params?: TParams) => Promise<PageApiResponse<TResult> | null>;
+    run: (params?: TParams) => Promise<PageApiResponse<TResult> | null>;
+    setResponse: Dispatch<SetStateAction<PageApiResponse<TResult> | null>>;
+    setResult: Dispatch<SetStateAction<TResult | null>>;
+    setData: Dispatch<SetStateAction<TData | null>>;
+}
+declare const useDataSource: <TResult = unknown, TData = TResult, TParams extends Record<string, unknown> = Record<string, unknown>>(name: string, options?: UseDataSourceOptions<TResult, TData, TParams>) => UseDataSourceResult<TResult, TData, TParams>;
+
+interface UseFormViewPermissionsOptions {
+    appType?: string;
+    immediate?: boolean;
+}
+interface UseFormViewPermissionsState {
+    summary: ViewPermissionSummary;
+    response: PageApiResponse<ViewPermissionSummary> | null;
+    loading: boolean;
+    error: Error | null;
+    refresh: () => Promise<PageApiResponse<ViewPermissionSummary> | null>;
+    can: (operation: ViewOperationPermission) => boolean;
+    getFieldPermission: (fieldName: string) => ViewFieldPermissionValue | null;
+}
+declare const useFormViewPermissions: (formUuid: string, options?: UseFormViewPermissionsOptions) => UseFormViewPermissionsState;
+
+declare const useMessage: () => PageMessageApi;
+
+declare const useModal: () => PageModalApi;
+
+declare const useNavigation: () => PageNavigationApi;
+
+declare const usePageContext: () => PageContext;
+
+declare const usePageProps: <T extends object = Record<string, unknown>>() => T;
+
+declare const usePageRoute: () => PageRouteInfo;
+
+declare const usePageSdk: () => PageSdk;
+
+export { PageApiResponse, PageContext, PageMessageApi, PageModalApi, PageNavigationApi, PageProvider, PageRouteInfo, PageSdk, PageUserInfo, PageUserType, ViewFieldPermissionValue, ViewOperationPermission, ViewPermissionSummary, createReactPage, useCurrentUser, useDataSource, useFormViewPermissions, useMessage, useModal, useNavigation, usePageContext, usePageProps, usePageRoute, usePageSdk };

package/dist/react/index.d.ts

@@ -0,0 +1,77 @@
+import React, { Dispatch, SetStateAction } from 'react';
+import { PageContext, PageUserInfo, PageUserType, PageApiResponse, ViewPermissionSummary, ViewOperationPermission, ViewFieldPermissionValue, PageMessageApi, PageModalApi, PageNavigationApi, PageRouteInfo, PageSdk } from '../index.js';
+export { ApiPermissionListParams, ApproveTaskParams, AssignPermissionsParams, AssignRolesParams, BatchAddUsersToRoleParams, BatchSendNotificationByTypeParams, ChangeUserRoleParams, CreateApiPermissionParams, CreateFormPermissionGroupDto, CreatePagePermissionGroupDto, CreateRoleParams, CreateUiPermissionParams, CreateUserParams, DataManagementConfigParams, DataManagementFilterState, DataPermissionConditionDto, DataPermissionDto, DataPermissionRuleDto, FieldPermissionDto, FormAdvancedSearchParams, FormChangeRecordParams, FormCreateParams, FormExportParams, FormGetDetailParams, FormImportParams, FormPermissionGroup, FormRemoveParams, FormSearchParams, FormUpdateParams, GetProcessInstanceParams, GetUserRolesParams, ImportExportRecordDownloadParams, ImportExportRecordQuery, InstanceStatus, NotificationChannel, NotificationMessageRecord, PageApiPermissionRecord, PageAppInfo, PageBinaryResponse, PageBridgeApi, PageDataManagementConfig, PageDataSourceDescriptor, PageDepartmentInfo, PageHttpMethod, PageInfo, PageListResult, PageOffsetListResult, PagePermissionGroup, PagePermissionInfo, PageQueryValue, PageRequestOptions, PageRoleRecord, PageScope, PageSdkError, PageSdkMeta, PageTransportDownloadPayload, PageTransportRequestPayload, PageUiPermissionRecord, PageUiPermissionType, PageUserRecord, ProcessApproveAction, QueryFormPermissionGroupDto, QueryPagePermissionGroupDto, RoleListParams, RoleUsersParams, SaveDataManagementConfigParams, SearchComponentName, SearchExpression, SearchFieldKey, SearchGroup, SearchLogic, SearchOperator, SearchRule, SearchSortItem, SearchSystemField, SendNotificationByTypeParams, SendNotificationResult, SubFormRule, SwitchAppRoleParams, SwitchPlatformRoleParams, TerminateProcessInstanceParams, TriggerCallbackTaskParams, UiPermissionListParams, UpdateApiPermissionParams, UpdateFormPermissionGroupDto, UpdatePagePermissionGroupDto, UpdateRoleParams, UpdateUiPermissionParams, UpdateUserParams, UserListParams, UserMenuPermissionsResponse, ValidateUserParams, createPageSdk } from '../index.js';
+
+declare const createReactPage: (AppComponent: React.ComponentType) => {
+    mount: (el: HTMLElement, context: PageContext) => void;
+    update: (el: HTMLElement, context: PageContext) => void;
+    unmount: () => void;
+};
+
+interface PageProviderProps {
+    context: PageContext;
+    children: React.ReactNode;
+}
+declare const PageProvider: React.FC<PageProviderProps>;
+
+interface CurrentUserState {
+    user: PageUserInfo & {
+        userType: PageUserType;
+        isGuest: boolean;
+    };
+    isGuest: boolean;
+    isInternalUser: boolean;
+    displayName: string;
+    primaryDepartment: NonNullable<PageUserInfo["departments"]>[number] | null;
+}
+declare const useCurrentUser: () => CurrentUserState;
+
+interface UseDataSourceOptions<TResult = unknown, TData = TResult, TParams extends Record<string, unknown> = Record<string, unknown>> {
+    params?: TParams;
+    immediate?: boolean;
+    transform?: (result: TResult, response: PageApiResponse<TResult>) => TData;
+}
+interface UseDataSourceResult<TResult = unknown, TData = TResult, TParams extends Record<string, unknown> = Record<string, unknown>> {
+    response: PageApiResponse<TResult> | null;
+    result: TResult | null;
+    data: TData | null;
+    loading: boolean;
+    error: Error | null;
+    refresh: (params?: TParams) => Promise<PageApiResponse<TResult> | null>;
+    run: (params?: TParams) => Promise<PageApiResponse<TResult> | null>;
+    setResponse: Dispatch<SetStateAction<PageApiResponse<TResult> | null>>;
+    setResult: Dispatch<SetStateAction<TResult | null>>;
+    setData: Dispatch<SetStateAction<TData | null>>;
+}
+declare const useDataSource: <TResult = unknown, TData = TResult, TParams extends Record<string, unknown> = Record<string, unknown>>(name: string, options?: UseDataSourceOptions<TResult, TData, TParams>) => UseDataSourceResult<TResult, TData, TParams>;
+
+interface UseFormViewPermissionsOptions {
+    appType?: string;
+    immediate?: boolean;
+}
+interface UseFormViewPermissionsState {
+    summary: ViewPermissionSummary;
+    response: PageApiResponse<ViewPermissionSummary> | null;
+    loading: boolean;
+    error: Error | null;
+    refresh: () => Promise<PageApiResponse<ViewPermissionSummary> | null>;
+    can: (operation: ViewOperationPermission) => boolean;
+    getFieldPermission: (fieldName: string) => ViewFieldPermissionValue | null;
+}
+declare const useFormViewPermissions: (formUuid: string, options?: UseFormViewPermissionsOptions) => UseFormViewPermissionsState;
+
+declare const useMessage: () => PageMessageApi;
+
+declare const useModal: () => PageModalApi;
+
+declare const useNavigation: () => PageNavigationApi;
+
+declare const usePageContext: () => PageContext;
+
+declare const usePageProps: <T extends object = Record<string, unknown>>() => T;
+
+declare const usePageRoute: () => PageRouteInfo;
+
+declare const usePageSdk: () => PageSdk;
+
+export { PageApiResponse, PageContext, PageMessageApi, PageModalApi, PageNavigationApi, PageProvider, PageRouteInfo, PageSdk, PageUserInfo, PageUserType, ViewFieldPermissionValue, ViewOperationPermission, ViewPermissionSummary, createReactPage, useCurrentUser, useDataSource, useFormViewPermissions, useMessage, useModal, useNavigation, usePageContext, usePageProps, usePageRoute, usePageSdk };

package/dist/react/index.js

@@ -0,0 +1,307 @@
+import {
+  createPageSdk
+} from "../chunk-R77DYKUJ.js";
+
+// src/react/createReactPage.tsx
+import { StyleProvider } from "@ant-design/cssinjs";
+import { App as AntdApp, ConfigProvider } from "antd";
+import zhCN from "antd/locale/zh_CN";
+import { createRoot } from "react-dom/client";
+
+// src/react/provider.tsx
+import { useMemo } from "react";
+
+// src/react/store.ts
+import { createContext, useContext } from "react";
+var ReactPageContext = createContext(null);
+var usePageSdkStore = () => {
+  const store = useContext(ReactPageContext);
+  if (!store) {
+    throw new Error("usePageSdkStore \u5FC5\u987B\u5728 PageProvider \u5185\u4F7F\u7528");
+  }
+  return store;
+};
+
+// src/react/provider.tsx
+import { jsx } from "react/jsx-runtime";
+var PageProvider = ({
+  context,
+  children
+}) => {
+  const value = useMemo(
+    () => ({
+      context,
+      sdk: createPageSdk(context)
+    }),
+    [context]
+  );
+  return /* @__PURE__ */ jsx(ReactPageContext.Provider, { value, children });
+};
+
+// src/react/createReactPage.tsx
+import { jsx as jsx2 } from "react/jsx-runtime";
+var createRuntimeRoot = (el) => {
+  return createRoot(el);
+};
+var getStyleContainer = (el) => {
+  const rootNode = el.getRootNode?.();
+  if (typeof ShadowRoot !== "undefined" && rootNode instanceof ShadowRoot) {
+    return rootNode;
+  }
+  return document.head;
+};
+var createReactPage = (AppComponent) => {
+  let root = null;
+  let currentContainer = null;
+  const render = (el, context) => {
+    if (!root || currentContainer !== el) {
+      root?.unmount();
+      root = createRuntimeRoot(el);
+      currentContainer = el;
+    }
+    root.render(
+      /* @__PURE__ */ jsx2(StyleProvider, { layer: true, container: getStyleContainer(el), children: /* @__PURE__ */ jsx2(ConfigProvider, { locale: zhCN, theme: { cssVar: {} }, children: /* @__PURE__ */ jsx2(AntdApp, { children: /* @__PURE__ */ jsx2(PageProvider, { context, children: /* @__PURE__ */ jsx2(AppComponent, {}) }) }) }) })
+    );
+  };
+  return {
+    mount: (el, context) => {
+      render(el, context);
+    },
+    update: (el, context) => {
+      render(el, context);
+    },
+    unmount: () => {
+      root?.unmount();
+      root = null;
+      currentContainer = null;
+    }
+  };
+};
+
+// src/react/hooks/useCurrentUser.ts
+import { useMemo as useMemo2 } from "react";
+
+// src/react/hooks/usePageContext.ts
+var usePageContext = () => {
+  return usePageSdkStore().context;
+};
+
+// src/react/hooks/useCurrentUser.ts
+var useCurrentUser = () => {
+  const { user } = usePageContext();
+  return useMemo2(() => {
+    const userType = user.userType === "guest" || user.isGuest ? "guest" : "normal";
+    const isGuest = userType === "guest";
+    return {
+      user: {
+        ...user,
+        isGuest,
+        userType
+      },
+      isGuest,
+      isInternalUser: !isGuest,
+      displayName: user.name || user.username || user.id,
+      primaryDepartment: user.departments?.[0] || null
+    };
+  }, [user]);
+};
+
+// src/react/hooks/useDataSource.ts
+import { useCallback, useEffect, useRef, useState } from "react";
+
+// src/react/hooks/usePageSdk.ts
+var usePageSdk = () => {
+  return usePageSdkStore().sdk;
+};
+
+// src/react/hooks/useDataSource.ts
+var createParamsSignature = (value) => {
+  try {
+    return JSON.stringify(value || {});
+  } catch {
+    return "";
+  }
+};
+var useDataSource = (name, options = {}) => {
+  const sdk = usePageSdk();
+  const { params, immediate = true, transform } = options;
+  const paramsRef = useRef(params);
+  const transformRef = useRef(transform);
+  const paramsSignature = createParamsSignature(params);
+  const [response, setResponse] = useState(
+    null
+  );
+  const [result, setResult] = useState(null);
+  const [data, setData] = useState(null);
+  const [loading, setLoading] = useState(false);
+  const [error, setError] = useState(null);
+  paramsRef.current = params;
+  transformRef.current = transform;
+  const run = useCallback(
+    async (overrideParams) => {
+      setLoading(true);
+      setError(null);
+      try {
+        const response2 = await sdk.dataSource.run(
+          name,
+          overrideParams || paramsRef.current || {}
+        );
+        setResponse(response2);
+        setResult(response2.result);
+        const activeTransform = transformRef.current;
+        const nextData = activeTransform ? activeTransform(response2.result, response2) : response2.result ?? null;
+        setData(nextData);
+        return response2;
+      } catch (runtimeError) {
+        const nextError = runtimeError instanceof Error ? runtimeError : new Error(String(runtimeError));
+        setError(nextError);
+        setResponse(null);
+        setResult(null);
+        return null;
+      } finally {
+        setLoading(false);
+      }
+    },
+    [name, sdk.dataSource]
+  );
+  useEffect(() => {
+    if (!immediate) {
+      return;
+    }
+    void run();
+  }, [immediate, paramsSignature, run]);
+  return {
+    response,
+    result,
+    data,
+    loading,
+    error,
+    refresh: run,
+    run,
+    setResponse,
+    setResult,
+    setData
+  };
+};
+
+// src/react/hooks/useFormViewPermissions.ts
+import { useCallback as useCallback2, useEffect as useEffect2, useMemo as useMemo3, useState as useState2 } from "react";
+var EMPTY_SUMMARY = {
+  fieldPermissions: {},
+  operations: []
+};
+var toError = (error) => {
+  if (error instanceof Error) {
+    return error;
+  }
+  if (typeof error === "object" && error !== null && "message" in error && typeof error.message === "string") {
+    return new Error(error.message);
+  }
+  return new Error(String(error || "\u83B7\u53D6\u67E5\u770B\u6001\u6743\u9650\u5931\u8D25"));
+};
+var useFormViewPermissions = (formUuid, options = {}) => {
+  const sdk = usePageSdk();
+  const [summary, setSummary] = useState2(EMPTY_SUMMARY);
+  const [response, setResponse] = useState2(null);
+  const [loading, setLoading] = useState2(false);
+  const [error, setError] = useState2(null);
+  const immediate = options.immediate ?? true;
+  const refresh = useCallback2(async () => {
+    const normalizedFormUuid = String(formUuid || "").trim();
+    if (!normalizedFormUuid) {
+      setSummary(EMPTY_SUMMARY);
+      setResponse(null);
+      return null;
+    }
+    setLoading(true);
+    setError(null);
+    try {
+      const nextResponse = await sdk.permission.formGroup.getViewPermissionSummary({
+        appType: options.appType,
+        formUuid: normalizedFormUuid
+      });
+      const nextSummary = nextResponse.result || EMPTY_SUMMARY;
+      setResponse(nextResponse);
+      setSummary({
+        fieldPermissions: nextSummary.fieldPermissions || {},
+        operations: nextSummary.operations || []
+      });
+      return nextResponse;
+    } catch (requestError) {
+      const nextError = toError(requestError);
+      setError(nextError);
+      setResponse(null);
+      setSummary(EMPTY_SUMMARY);
+      return null;
+    } finally {
+      setLoading(false);
+    }
+  }, [formUuid, options.appType, sdk]);
+  useEffect2(() => {
+    if (!immediate) {
+      return;
+    }
+    void refresh();
+  }, [immediate, refresh]);
+  const operationSet = useMemo3(
+    () => new Set(summary.operations),
+    [summary.operations]
+  );
+  const can = useCallback2(
+    (operation) => operationSet.has(operation),
+    [operationSet]
+  );
+  const getFieldPermission = useCallback2(
+    (fieldName) => summary.fieldPermissions[fieldName] || null,
+    [summary.fieldPermissions]
+  );
+  return {
+    summary,
+    response,
+    loading,
+    error,
+    refresh,
+    can,
+    getFieldPermission
+  };
+};
+
+// src/react/hooks/useMessage.ts
+var useMessage = () => {
+  return usePageContext().ui.message;
+};
+
+// src/react/hooks/useModal.ts
+var useModal = () => {
+  return usePageContext().ui.modal;
+};
+
+// src/react/hooks/useNavigation.ts
+var useNavigation = () => {
+  return usePageContext().navigation;
+};
+
+// src/react/hooks/usePageProps.ts
+var usePageProps = () => {
+  return usePageContext().page.props;
+};
+
+// src/react/hooks/usePageRoute.ts
+var usePageRoute = () => {
+  return usePageContext().route;
+};
+export {
+  PageProvider,
+  createPageSdk,
+  createReactPage,
+  useCurrentUser,
+  useDataSource,
+  useFormViewPermissions,
+  useMessage,
+  useModal,
+  useNavigation,
+  usePageContext,
+  usePageProps,
+  usePageRoute,
+  usePageSdk
+};

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "sy-page-sdk",
+  "version": "0.1.0",
+  "description": "Custom code page SDK for sy lowcode platform",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "import": "./dist/react/index.js",
+      "require": "./dist/react/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "package.json",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts src/react/index.ts --format esm,cjs --dts --clean --out-dir dist --tsconfig tsconfig.build.json",
+    "prepublishOnly": "pnpm build"
+  },
+  "peerDependencies": {
+    "@ant-design/cssinjs": ">=1",
+    "antd": ">=5",
+    "react": ">=18",
+    "react-dom": ">=18"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.0",
+    "typescript": "^5.7.0"
+  }
+}