@genispace/geniapp
公共,版本开发商合同 建造GeniApp。 这个软件包有意独立于私人的GeniSpace前端单列波.
所有权边界
frontend/ geniapp/ applications/
├── apps/* └── @genispace/geniapp └── apps/*
└── packages/shared-* (private) ├── ui + kit ├── @genispace/sdk
├── Shell bridge └── @genispace/geniapp
├── hooks + runtime
├── theme + i18n contract
└── Vite bundle plugin
frontend/packages/shared-*属于只属于平台前端的,并且从来不是GeniApp依赖.@genispace/geniapp是内建、自定义和Workbench-exported GeniApps所使用的公共UI/runtime/建筑合同.@genispace/sdk是公共平台API SDK. 此软件包不重复其HTTP/SSE客户端.@genispace/[email protected]需要准确@genispace/[email protected]。SDK版本是GeniApp运行时合同的一部分,在包装或出版前检查.
安装
从 npm 安装两个公共软件包 。 GeniApp将他们的支持的 SDK 版本精确地放入了插针,因此应用程序应该使用下面显示的匹配的 SDK 版本.
pnpm add @genispace/[email protected] @genispace/[email protected] react react-dom react-router-dom i18next react-i18next
公开条目
| 条目 | 稳定 | 目的 |
|---|---|---|
@genispace/geniapp | 稳定 | 应用布局、钩子和壳桥 |
@genispace/geniapp/ui | 稳定 | 应用侧边栏/页/状态/形式原始人 |
@genispace/geniapp/kit | 稳定 | 加工的阴影样式组件包 |
@genispace/geniapp/hooks | 稳定 | 非洲区域局、路由、地方和平台客户助手 |
@genispace/geniapp/shell | 稳定 | 安全 iframe 上下文、 主题、 地块和路由同步 |
@genispace/geniapp/vite | 稳定 | 特性/数据捆绑复制和版本的基本路径帮助器 |
@genispace/geniapp/ai | 稳定 | 管理数据源和AI辅助应用模式 |
@genispace/geniapp/storage | 稳定 | 已认证的平台存储 UI/ helpers |
@genispace/geniapp/dashboard | 稳定 | 剪贴板过滤器、 KPI 和图表模式 |
@genispace/geniapp/case-workspace | 稳定 | 案件工作空间合同 |
@genispace/geniapp/task-workspace | 稳定 | 工作空间合同 |
@genispace/geniapp/components | 稳定 | 每个 GeniApp 精确 Workbench 视图渲染器和运行时提供者 |
@genispace/geniapp/components/renderers/* | 稳定 | 开发者- 改进组件- 家庭切入点, 如 table, (中文(简体) ), form 财务报告和审定财务报表 chart |
@genispace/geniapp/components/styles.css | 稳定 | 共享组件、布局、移动和外观样式 |
这些条目输出的符号只有公用. 下方的文件 src/ 财务报告和审定财务报表 dist/ 是执行细节,不能通过包出口导入.
构建创建单独主机共享字体捆绑的工具可能会解决
@genispace/geniapp/fonts.css; 应用程序应继续导入
@genispace/geniapp/styles.css。 。 。 .
应用程序设置
import { AppPage, AppSidebar } from '@genispace/geniapp/ui';
import { Button, Card } from '@genispace/geniapp/kit';
import { GeniAppShellBridge } from '@genispace/geniapp/shell';
import '@genispace/geniapp/styles.css';
export function App() {
return (
<>
<GeniAppShellBridge
identifier="customer-operations"
allowedShellOrigins={['https://app.genispace.ai']}
/>
<AppSidebar groups={[]} />
<AppPage title="Customer operations">
<Card><Button>New customer</Button></Card>
</AppPage>
</>
);
}
allowedShellOrigins 应列出生产壳牌的来源。 该桥还接受iframe文件的推荐人,只有在没有生产来源时才回落到当地的壳牌起源. 信件不能给自己的发送者信任 .
尾风
// tailwind.config.js
import geniappPreset from '@genispace/geniapp/tailwind-preset';
export default {
presets: [geniappPreset],
content: [
'./index.html',
'./src/**/*.{js,ts,jsx,tsx}',
'./node_modules/@genispace/geniapp/dist/**/*.{js,mjs}',
],
};
样式表包含平台轻/暗语义符号,本地字体,应答应用程序布局规则和组件 CSS. 语言文本仍然为每个应用程序所拥有;共享组件接受标签或使用主机 react-i18next 供养.
Workbench 输出运行时间
Workbench导出一个精确的GeniApp版本并保存每个页面和组件在一个单独的React/TypeScript模块中. 公共组件运行时间是Workbench视图模式使用的相同执行,不导入私有编辑器:
import { createRoot } from 'react-dom/client';
import { BrowserRouter } from 'react-router-dom';
import {
GeniAppComponentProvider,
GeniAppWorkbench,
createPlatformHostAdapters,
} from '@genispace/geniapp/components';
import '@genispace/geniapp/components/styles.css';
import workbenchConfig from './config/workbench.config';
createRoot(document.getElementById('root')!).render(
<BrowserRouter>
<GeniAppComponentProvider
applicationId="customer-operations"
adapters={createPlatformHostAdapters({
applicationIdentifier: 'customer-operations',
datasourceIdentifiers: workbenchConfig.geniappRuntime?.datasourceIdentifiers,
})}
locale={localStorage.getItem('i18nextLng') || navigator.language}
localeMetadata={workbenchConfig.metadata}
themeId={workbenchConfig.themeId}
>
<GeniAppWorkbench
identifier="customer-operations"
config={workbenchConfig}
/>
</GeniAppComponentProvider>
</BrowserRouter>,
);
运行时间拥有准确的组件行为,布局,移动改造,平台适配器,主题桥和地语桥. 导出组件模块拥有针对应用程序的道具,数据和自定义样式,因此开发人员可以编辑或替换一个组件而无需读取一纸快照. 没有遗产 workbench 软件包条目: 导出特性在 components 合同正式生效.
发布生命周期介绍可从以下来源获取: @genispace/geniapp/components/release. 这些组件是故意由主机控制且无副作用的:该平台仍然负责授权,有效版本解析,预览会员身份和发布注释确认. 运行时平台适配器可以通过已安装的应用程序版本解决可移植数据源,数据集,代理,任务,工作流程,操作员,知识基础和技能等参考,而无需嵌入源-空间UUUID.
维特
安装了版本和数据源版本
部署应用程序版本可以执行迁移并安装其平台资源. 安装后, 应用程序所有者会选择将其发布或显示为选中的 预览成员。 预览不会孤立共享数据库计划:开发者必须保存 策略和共享资源变化与服务应用程序的相兼容.
使用 GeniAppShellBridge 财务报告和审定财务报表 createPlatformHostAdapters 用于出口组件请求.
该桥提供应用程序的身份和有效版本;适配器发送
上下文和每个读、写和计划请求的逻辑数据源标识符.
服务器授权受众并绘制可选源 version 数字到
为该应用程序版本安装了不可改变的执行修订版。 不替换 a
根据先前的请求返回物理修订, 或全局更改数据源默认值
正在测试候选版本.
这个 queryManagedDatasourceRows 财务报告和审定财务报表 executeManagedDatasourceOperation 帮助者来自
@genispace/geniapp/ai 使用相同的绑定值时,请使用
贝壳。 跨应用程序的帮助者保留他们现有的共享资源行为.
自定义 SDK/ fetch 集成必须携带 X-Application-Id 财务报告和审定财务报表
X-GeniApp-Resource-Identifier 数据源请求; 可选
X-GeniApp-Release-Channel: stable 可选择退出预览,但不能允许预览访问.
在 API CORS 配置中允许这些信头 .
已经部署的捆绑不通过平台升级重写 。 重建一个候选人 使用此运行时间更改数据源执行(或等同的请求上下文合同). 未经更改的数据源合同可以重新使用它们安装的执行修改.
import fs from 'node:fs';
import path from 'node:path';
import { fileURLToPath } from 'node:url';
import { defineConfig } from 'vite';
import react from '@vitejs/plugin-react';
import {
copyGeniAppBundle,
geniappBasePath,
geniappManualChunks,
geniappOptimizeDeps,
} from '@genispace/geniapp/vite';
const appRoot = path.dirname(fileURLToPath(import.meta.url));
const pkg = JSON.parse(fs.readFileSync(path.join(appRoot, 'package.json'), 'utf8'));
export default defineConfig(({ command, mode }) => ({
base: geniappBasePath({ command, mode, identifier: 'customer-operations', version: pkg.version }),
plugins: [react(), copyGeniAppBundle({ appRoot })],
optimizeDeps: geniappOptimizeDeps,
build: { rollupOptions: { output: { manualChunks: geniappManualChunks } } },
}));
插件副本 manifest.json 一、导 言 data/ 合同订立 dist/,并在当地开发期间提供同样的文档。 它不创建 GeniSpace 源寄存器的别名 .
当地质量大门
pnpm install
pnpm check:sdk-version
pnpm type-check
pnpm test
pnpm pack:check
pack:check 将实际的 npm 文物建为 .pack/消费者接受测试必须安装该焦油球,而不是进口该储存库的来源,以便抓住缺失的出口和未申报的依赖.
发布政策
- 随语义发相. 删除或更改导出符号、 Shell 信件、 CSS 符號或表/ 构建行为是一种突破性改变 .
- 应用程序在发布锁文件中标出精确的版本 。 革新是明确和检验的.
- 每个 GeniApp 包放出一个精确的针
@genispace/sdk对应版本。 支持另一个 SDK 版本需要经过审查的 GeniApp 发布,即使 SDK 更改在其他方面是后向兼容的. - 在CI,软件包名所有权和麻省理工学院许可证之后,用npm出处的干净的Git标签发布.
- 旧的
frontend-packages寄存器仅作为仅读的历史取出而留存。 没有主动应用程序或平台前端从中解析代码. - 完整的所有权决定、截断程序和验收证据记录如下:
docs/ARCHITECTURE_AND_MIGRATION.md。 。 。 .