npm - @nocobase/app - Versions diffs - 2.0.22 → 2.1.0-alpha.10 - Mend

@nocobase/app 2.0.22 → 2.1.0-alpha.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (146) hide show

package/client-v2/index.html ADDED Viewed

@@ -0,0 +1,25 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>NocoBase v2</title>
+    <script>
+      window.__nocobase_public_path__ = window.__nocobase_public_path__ || '<%= BASE_URL %>';
+      window.__nocobase_api_base_url__ = window.__nocobase_api_base_url__ || '<%= API_BASE_URL %>';
+      window.__nocobase_api_client_storage_prefix__ =
+        window.__nocobase_api_client_storage_prefix__ || '<%= API_CLIENT_STORAGE_PREFIX %>';
+      window.__nocobase_api_client_storage_type__ =
+        window.__nocobase_api_client_storage_type__ || '<%= API_CLIENT_STORAGE_TYPE %>';
+      window.__nocobase_api_client_share_token__ =
+        window.__nocobase_api_client_share_token__ || '<%= API_CLIENT_SHARE_TOKEN %>';
+      window.__nocobase_ws_url__ = window.__nocobase_ws_url__ || '<%= WS_URL %>';
+      window.__nocobase_ws_path__ = window.__nocobase_ws_path__ || '<%= WS_PATH %>';
+      window.__esm_cdn_base_url__ = window.__esm_cdn_base_url__ || '<%= ESM_CDN_BASE_URL %>';
+      window.__esm_cdn_suffix__ = window.__esm_cdn_suffix__ || '<%= ESM_CDN_SUFFIX %>';
+    </script>
+  </head>
+  <body>
+    <div id="root"></div>
+  </body>
+</html>

package/client-v2/rsbuild.config.ts ADDED Viewed

@@ -0,0 +1,242 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { defineConfig } from '@rsbuild/core';
+import { pluginLess } from '@rsbuild/plugin-less';
+import { pluginNodePolyfill } from '@rsbuild/plugin-node-polyfill';
+import { pluginReact } from '@rsbuild/plugin-react';
+import { getRsbuildAlias } from '../../devtools/rsbuildConfig';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+function ensurePublicPath(value: string) {
+  let normalized = value || '/v2/';
+  if (!normalized.startsWith('/')) {
+    normalized = `/${normalized}`;
+  }
+  if (!normalized.endsWith('/')) {
+    normalized = `${normalized}/`;
+  }
+  return normalized;
+}
+function toNumber(value: string | undefined, fallback: number) {
+  const parsed = Number(value);
+  return Number.isFinite(parsed) ? parsed : fallback;
+}
+function createDefineValues(v2PublicPath: string) {
+  return {
+    'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV || 'development'),
+    'import.meta.env.BASE_URL': JSON.stringify(v2PublicPath),
+    'import.meta.env.API_BASE_URL': JSON.stringify(process.env.API_BASE_URL || process.env.API_BASE_PATH || ''),
+    'import.meta.env.API_CLIENT_STORAGE_PREFIX': JSON.stringify(process.env.API_CLIENT_STORAGE_PREFIX || ''),
+    'import.meta.env.API_CLIENT_STORAGE_TYPE': JSON.stringify(process.env.API_CLIENT_STORAGE_TYPE || ''),
+    'import.meta.env.API_CLIENT_SHARE_TOKEN': JSON.stringify(process.env.API_CLIENT_SHARE_TOKEN || 'false'),
+    'import.meta.env.WS_URL': JSON.stringify(process.env.WEBSOCKET_URL || ''),
+    'import.meta.env.WS_PATH': JSON.stringify(process.env.WS_PATH || ''),
+    'import.meta.env.ESM_CDN_BASE_URL': JSON.stringify(process.env.ESM_CDN_BASE_URL || 'https://esm.sh'),
+    'import.meta.env.ESM_CDN_SUFFIX': JSON.stringify(process.env.ESM_CDN_SUFFIX || ''),
+  };
+}
+function createTemplateParameters(v2PublicPath: string) {
+  return {
+    BASE_URL: v2PublicPath,
+    API_BASE_URL: process.env.API_BASE_URL || process.env.API_BASE_PATH || '',
+    API_CLIENT_STORAGE_PREFIX: process.env.API_CLIENT_STORAGE_PREFIX || '',
+    API_CLIENT_STORAGE_TYPE: process.env.API_CLIENT_STORAGE_TYPE || '',
+    API_CLIENT_SHARE_TOKEN: process.env.API_CLIENT_SHARE_TOKEN || 'false',
+    WS_URL: process.env.WEBSOCKET_URL || '',
+    WS_PATH: process.env.WS_PATH || '',
+    ESM_CDN_BASE_URL: process.env.ESM_CDN_BASE_URL || 'https://esm.sh',
+    ESM_CDN_SUFFIX: process.env.ESM_CDN_SUFFIX || '',
+  };
+}
+export default defineConfig(({ command }) => {
+  const isBuild = command === 'build';
+  const appPublicPath = ensurePublicPath(process.env.APP_PUBLIC_PATH || '/');
+  const apiBasePath = ensurePublicPath(process.env.API_BASE_PATH || '/api/');
+  const v2PublicPath = ensurePublicPath(`${appPublicPath.replace(/\/$/, '')}/v2/`);
+  const hmrPath = `${v2PublicPath.replace(/\/$/, '')}/__rspack_hmr`;
+  const v2Port = toNumber(process.env.APP_V2_PORT, 13002);
+  const hmrClientHost = process.env.RSPACK_HMR_CLIENT_HOST || 'localhost';
+  const hmrClientPort = toNumber(process.env.RSPACK_HMR_CLIENT_PORT || process.env.APP_PORT, v2Port);
+  const proxyTargetUrl = process.env.PROXY_TARGET_URL || `http://127.0.0.1:${process.env.APP_PORT || 13001}`;
+  const workspaceAliases = getRsbuildAlias();
+  return {
+    plugins: [pluginReact(), pluginLess(), pluginNodePolyfill()],
+    resolve: {
+      alias: workspaceAliases,
+    },
+    source: {
+      entry: {
+        index: path.resolve(__dirname, 'src/main.tsx'),
+      },
+      tsconfigPath: path.resolve(__dirname, 'tsconfig.json'),
+      define: createDefineValues(v2PublicPath),
+    },
+    html: {
+      template: path.resolve(__dirname, 'index.html'),
+      scriptLoading: isBuild ? 'module' : 'defer',
+      templateParameters: createTemplateParameters(v2PublicPath),
+    },
+    output: {
+      target: 'web',
+      distPath: {
+        root: path.resolve(__dirname, '../dist/client/v2'),
+        js: 'assets',
+        jsAsync: 'assets',
+        css: 'assets',
+        cssAsync: 'assets',
+        svg: 'assets',
+        font: 'assets',
+        image: 'assets',
+        media: 'assets',
+      },
+      filename: {
+        js: '[name]-[contenthash:8].js',
+        css: '[name]-[contenthash:8].css',
+        svg: '[name]-[contenthash:8][ext][query]',
+        font: '[name]-[contenthash:8][ext][query]',
+        image: '[name]-[contenthash:8][ext][query]',
+        media: '[name]-[contenthash:8][ext][query]',
+      },
+      assetPrefix: v2PublicPath,
+      cleanDistPath: true,
+      sourceMap: {
+        js: isBuild ? false : 'eval-cheap-module-source-map',
+        css: false,
+      },
+    },
+    server: {
+      base: v2PublicPath,
+      host: '0.0.0.0',
+      port: v2Port,
+      compress: true,
+      publicDir: false,
+      proxy: {
+        [apiBasePath]: {
+          target: proxyTargetUrl,
+          changeOrigin: true,
+          ws: true,
+          xfwd: true, // 这里会处理 X-Forwarded-For 头，添加客户端 IP 地址
+          pathRewrite: {
+            [`^${apiBasePath}`]: apiBasePath,
+          },
+          onProxyRes(proxyRes, req, res) {
+            if (req.headers.accept === 'text/event-stream') {
+              res.writeHead(res.statusCode, {
+                'Content-Type': 'text/event-stream',
+                'Cache-Control': 'no-transform',
+                Connection: 'keep-alive',
+              });
+            }
+          },
+        },
+      },
+      historyApiFallback: {
+        disableDotRule: true,
+        index: `${v2PublicPath}index.html`,
+      },
+    },
+    dev: {
+      assetPrefix: v2PublicPath,
+      lazyCompilation: false,
+      client: {
+        overlay: false,
+        protocol: 'ws',
+        host: hmrClientHost,
+        port: hmrClientPort,
+        path: hmrPath,
+      },
+      progressBar: true,
+    },
+    tools: {
+      rspack(config) {
+        config.target = ['web', 'es2020'];
+        config.output.module = isBuild;
+        config.output.chunkFormat = isBuild ? 'module' : 'array-push';
+        config.experiments = {
+          ...config.experiments,
+          outputModule: isBuild,
+        };
+        config.module.rules.push({
+          test: /\.svg$/i,
+          issuer: /\.[jt]sx?$/,
+          use: ['@svgr/webpack'],
+        });
+        config.optimization = {
+          ...config.optimization,
+          runtimeChunk: 'single',
+          splitChunks: {
+            chunks: 'all',
+            cacheGroups: {
+              antdEcosystem: {
+                test: /[\\/]node_modules[\\/](?:rc-[^\\/]+|@rc-component[\\/][^\\/]+|@ant-design[\\/](?!(?:icons|icons-svg)[\\/])[^\\/]+)[\\/]/,
+                name: 'vendor-antd-ecosystem',
+                chunks: 'all',
+                priority: 45,
+                enforce: true,
+                minSize: 0,
+              },
+              momentLocales: {
+                test: /[\\/]node_modules[\\/]moment[\\/](?:locale[\\/]|moment\.js$)/,
+                name: 'vendor-moment',
+                chunks: 'all',
+                priority: 44,
+                enforce: true,
+                minSize: 0,
+              },
+              lodashCjs: {
+                test: /[\\/]node_modules[\\/]lodash[\\/]lodash\.js$/,
+                name: 'vendor-lodash',
+                chunks: 'all',
+                priority: 43,
+                enforce: true,
+                minSize: 0,
+              },
+              ses: {
+                test: /[\\/]node_modules[\\/]ses[\\/]/,
+                name: 'vendor-ses',
+                chunks: 'all',
+                priority: 42,
+                enforce: true,
+                minSize: 0,
+              },
+              antdIcons: {
+                test: /[\\/]node_modules[\\/]@ant-design[\\/](?:icons|icons-svg)[\\/]/,
+                name: 'vendor-antd-icons',
+                chunks: 'all',
+                priority: 40,
+                enforce: true,
+                minSize: 0,
+              },
+              antd: {
+                test: /[\\/]node_modules[\\/]antd[\\/]/,
+                name: 'vendor-antd',
+                chunks: 'all',
+                priority: 30,
+                enforce: true,
+                minSize: 0,
+              },
+            },
+          },
+        };
+        config.performance = false;
+        config.stats = 'errors-warnings';
+      },
+    },
+  };
+});

package/client-v2/src/env.d.ts ADDED Viewed

@@ -0,0 +1,24 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+interface ImportMetaEnv {
+  readonly BASE_URL?: string;
+  readonly API_BASE_URL?: string;
+  readonly API_CLIENT_STORAGE_PREFIX?: string;
+  readonly API_CLIENT_STORAGE_TYPE?: string;
+  readonly API_CLIENT_SHARE_TOKEN?: string;
+  readonly WS_URL?: string;
+  readonly WS_PATH?: string;
+  readonly ESM_CDN_BASE_URL?: string;
+  readonly ESM_CDN_SUFFIX?: string;
+}
+interface ImportMeta {
+  readonly env: ImportMetaEnv;
+}

package/client-v2/src/main.tsx ADDED Viewed

@@ -0,0 +1,105 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Application } from '@nocobase/client-v2';
+import { AppInfoDemoPlugin } from './plugins/AppInfoDemoPlugin';
+declare global {
+  interface Window {
+    __nocobase_public_path__?: string;
+    __nocobase_api_base_url__?: string;
+    __nocobase_api_client_storage_prefix__?: string;
+    __nocobase_api_client_storage_type__?: string;
+    __nocobase_api_client_share_token__?: boolean | string;
+    __nocobase_ws_url__?: string;
+    __nocobase_ws_path__?: string;
+    __nocobase_v2_app__?: Application;
+  }
+}
+function ensureSlash(pathname: string, fallback: string) {
+  if (!pathname) {
+    return fallback;
+  }
+  let normalized = pathname.trim();
+  if (!normalized.startsWith('/')) {
+    normalized = `/${normalized}`;
+  }
+  if (!normalized.endsWith('/')) {
+    normalized = `${normalized}/`;
+  }
+  return normalized;
+}
+function inferRootPublicPathFromLocation() {
+  const marker = '/v2/';
+  const pathname = window.location.pathname;
+  const index = pathname.indexOf(marker);
+  if (index >= 0) {
+    return ensureSlash(pathname.slice(0, index), '/');
+  }
+  return '/';
+}
+function getRootPublicPath() {
+  const fromWindow = window.__nocobase_public_path__;
+  if (fromWindow) {
+    return ensureSlash(fromWindow.replace(/\/v2\/$/, '/'), '/');
+  }
+  const fromBase = import.meta.env.BASE_URL;
+  if (fromBase) {
+    return ensureSlash(fromBase.replace(/\/v2\/$/, '/'), '/');
+  }
+  return inferRootPublicPathFromLocation();
+}
+function getV2PublicPath() {
+  return ensureSlash(`${getRootPublicPath().replace(/\/$/, '')}/v2/`, '/v2/');
+}
+function parseShareToken(value: boolean | string | undefined) {
+  if (typeof value === 'boolean') {
+    return value;
+  }
+  return String(value || '').toLowerCase() === 'true';
+}
+type ClientStorageType = 'localStorage' | 'sessionStorage' | 'memory';
+function parseStorageType(value: string | undefined): ClientStorageType {
+  if (value === 'sessionStorage' || value === 'memory' || value === 'localStorage') {
+    return value;
+  }
+  return 'localStorage';
+}
+const rootPublicPath = getRootPublicPath();
+const v2PublicPath = getV2PublicPath();
+const app = new Application({
+  publicPath: v2PublicPath,
+  apiClient: {
+    shareToken: parseShareToken(window.__nocobase_api_client_share_token__ || import.meta.env.API_CLIENT_SHARE_TOKEN),
+    storageType: parseStorageType(
+      window.__nocobase_api_client_storage_type__ || import.meta.env.API_CLIENT_STORAGE_TYPE,
+    ),
+    storagePrefix:
+      window.__nocobase_api_client_storage_prefix__ || import.meta.env.API_CLIENT_STORAGE_PREFIX || 'NOCOBASE_',
+    baseURL: window.__nocobase_api_base_url__ || import.meta.env.API_BASE_URL || `${rootPublicPath}api/`,
+  },
+  ws: {
+    url: window.__nocobase_ws_url__ || import.meta.env.WS_URL || '',
+    basename: window.__nocobase_ws_path__ || import.meta.env.WS_PATH || `${rootPublicPath}ws`,
+  },
+  plugins: [AppInfoDemoPlugin],
+  loadRemotePlugins: false,
+});
+window.__nocobase_v2_app__ = app;
+app.mount('#root');

package/client-v2/src/plugins/AppInfoDemoPlugin.ts ADDED Viewed

@@ -0,0 +1,40 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Plugin } from '@nocobase/client-v2';
+export class AppInfoDemoPlugin extends Plugin {
+  async load() {
+    this.flowEngine.flowSettings.registerComponentLoaders({
+      DemoFlowSettingsLazyField: () => import('../settings/DemoFlowSettingsLazyField'),
+    });
+    this.router.add('demo.homepage', {
+      path: '/',
+      componentLoader: () => import('../routes/DemoHomepageRoute'),
+    });
+    this.router.add('demo.app-info', {
+      path: '/demo/app-info',
+      componentLoader: () => import('../routes/AppInfoDemoRoute'),
+    });
+    this.router.add('demo.flow-settings-component-loader', {
+      path: '/demo/flow-settings-component-loader',
+      componentLoader: () => import('../routes/FlowSettingsComponentLoaderDemoRoute'),
+    });
+    try {
+      const response = await this.app.apiClient.request({
+        url: 'app:getInfo',
+      });
+      console.log('[client-v2 demo plugin] /api/app:getInfo', response?.data);
+    } catch (error) {
+      console.error('[client-v2 demo plugin] failed to request /api/app:getInfo', error);
+    }
+  }
+}

package/client-v2/src/routes/AppInfoDemoRoute.tsx ADDED Viewed

@@ -0,0 +1,14 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import React from 'react';
+export default function AppInfoDemoRoute() {
+  return <div>App Info Demo Route</div>;
+}

package/client-v2/src/routes/DemoHomepageRoute.tsx ADDED Viewed

@@ -0,0 +1,28 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import React from 'react';
+import { Button } from 'antd';
+import { useNavigate } from 'react-router-dom';
+export default function DemoHomepageRoute() {
+  const navigate = useNavigate();
+  return (
+    <>
+      <div>
+        Demo Homepage Route
+        <Button onClick={() => navigate('/demo/app-info')}>Go to demo route</Button>
+      </div>
+      <div>
+        Demo flow settings page
+        <Button onClick={() => navigate('/demo/flow-settings-component-loader')}>Go to demo route</Button>
+      </div>
+    </>
+  );
+}

package/client-v2/src/routes/FlowSettingsComponentLoaderDemoRoute.tsx ADDED Viewed

@@ -0,0 +1,40 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { createForm } from '@formily/core';
+import { createSchemaField, FormProvider } from '@formily/react';
+import React from 'react';
+import { useApp } from '../../../../client-v2/src/hooks/useApp';
+const SchemaField = createSchemaField();
+export default function FlowSettingsComponentLoaderDemoRoute() {
+  const app = useApp();
+  const form = React.useMemo(() => createForm(), []);
+  return (
+    <div>
+      <div>Flow Settings Component Loader Demo Route</div>
+      <FormProvider form={form}>
+        <SchemaField
+          schema={{
+            type: 'object',
+            properties: {
+              demo: {
+                type: 'void',
+                'x-component': 'DemoFlowSettingsLazyField',
+              },
+            },
+          }}
+          components={app.flowEngine.flowSettings.components}
+        />
+      </FormProvider>
+    </div>
+  );
+}

package/client-v2/src/settings/DemoFlowSettingsLazyField.tsx ADDED Viewed

@@ -0,0 +1,14 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import React from 'react';
+export default function DemoFlowSettingsLazyField() {
+  return <div>Demo Flow Settings Lazy Field Loaded</div>;
+}

package/client-v2/tsconfig.json ADDED Viewed

@@ -0,0 +1,19 @@
+{
+  "extends": "../../../../tsconfig.json",
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "importHelpers": true,
+    "jsx": "react-jsx",
+    "esModuleInterop": true,
+    "sourceMap": true,
+    "baseUrl": "../../../../",
+    "strict": true,
+    "allowSyntheticDefaultImports": true,
+    "noEmit": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}