# @aglyn/tenant-feature-instance 中文文档

规范地址：https://npmcn.com/package/%40aglyn/tenant-feature-instance/

版本：1\.19\.0
npm 元数据更新时间：2026-11-07T14:02:03.042Z
中文译文更新时间：2026-11-05T22:16:06.132Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aglyn/tenant-feature-instance
原文对照：https://npmcn.com/package/%40aglyn/tenant-feature-instance/?lang=original
项目主页：https://aglyn.com/
源码仓库：https://github.com/aglyn/aglyn

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.7 MB，241 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：9 个
- peer 依赖：react ^19\.2\.8，firebase ^13\.0\.0，@mui/material ^9\.3\.1
- 首次发布：2026-09-20T23:55:02.136Z
- 最新版本发布：2026-11-07T14:02:02.660Z
- 近 30 天下载量：13382（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：153（近 12 个月 153 个）

## 中文简介

在Firebase网站SDK上与一个Aglyn网站实例合作的客户端-侧反向钩:Firebase服务提供商,Firestore文档和收藏钩,以及主机,屏幕,布局,组件及其版本的打入钩. 这主要是一个

## 安装

```sh
npm install @aglyn/tenant-feature-instance
```

也可以使用：`pnpm add @aglyn/tenant-feature-instance`、`yarn add @aglyn/tenant-feature-instance`、`bun add @aglyn/tenant-feature-instance`

## README

# @aglyn/tenant-fetature-instection (英语)

客户端反应钩子, 用于在 Aglyn 网站实例中工作 Firebase网络SDK:Firebase服务提供商、Firestore文档和 收集钩子,以及主机、屏幕、布局、组件和 他们的版本。 它主要是内部构件: Aglyn控制台和 控制台的一半 `@aglyn/plugins-*` 软件包读写站点数据 通过它。 只有针对客户端构建客户端时,才直接安装 Aglyn部署的Firestore.

> 从Aglyn monorepo出版到npm. 随后的版本 [语义版本](https://semver.org/)。 。 。 .

## 安装

```
npm install @aglyn/tenant-feature-instance
```

同伴依赖性 :

-   `react`
-   `firebase`
-   `@mui/material` (用于重复资源对话框)

## 里面有什么东西

消防队服务:

-   `FirebaseServicesProvider` 从 a 初始化 Firebase 应用程序 `firebaseConfig` 财务报告和审定财务报表 `appName`,并选择认证持久性和 Firestore 从它的本地缓存 `authPersistence` 道具 (英语).
-   `useFirebaseApp`, (中文(简体) ), `useFirestore`, (中文(简体) ), `useAuth`, (中文(简体) ), `useAnalytics`, (中文(简体) ), `useRemoteConfig`, (中文(简体) ), `useUser` 财务报告和审定财务报表 `useSigninCheck` 从中读取.
-   `fbClientAppOptions` 财务报告和审定财务报表 `FIREBASE_CLIENT_APP_NAME` 是客户端 配置 Aglyn 的应用,从环境变量读取.

一般消防车钩 :

-   `useFirestoreDoc` 财务报告和审定财务报表 `useFirestoreCollection` 订阅引用或 由调用者创建并返回的查询 `data`, (中文(简体) ), `status`, (中文(简体) ), `error` 是否为 数据仍有待当地撰写.
-   `usePagedCollection`,排序的页式收藏钩和切换器 收藏钩页通过更大的收藏.
-   `useDoc`, (中文(简体) ), `useDocData` 而修改文件的回调为下级 帮助键入的钩子从中构建 .

平台模型上打入的钩子 `@aglyn/aglyn`数字 :

-   `useHost`, (中文(简体) ), `useScreen`, (中文(简体) ), `useScreenVersion`, (中文(简体) ), `useLayout`, (中文(简体) ), `useLayoutVersion`, (中文(简体) ), `useComponent`,组件版本和形式版本的钩子及其 `...Ref` 对口单位`useHostRef`, (中文(简体) ), `useScreenRef` (见a/cn.9/wg.iii/wp.iii/wp.1号文件).
-   `usePluginConfig` 财务报告和审定财务报表 `useSitePluginConfig` 用于存储插件 配置 .
-   `useOrgPlan`组织名称、组织成员选项和 瞄准镜指针.
-   `useSiteContainerOptions` 财务报告和审定财务报表 `useOrgContainerOptions`a 的容器 排序插件宣布( 活动) 记录可以存档,以及 `ContainerPicker` (单位:千美元)`components/container-picker`,通过子路径,控制 每个文件表层都吸引他们.
-   `useHostResourceApi`, (中文(简体) ), `useHostVersionApi` 和重复资源钩 对话框`DuplicateResourceDialog`)呼叫控制台的资源API.

保存节点树 :

-   `saveNodesGuarded` 并且守护的种子会保存文档的节点 根据基线,并保存到 和从编辑表.

常数: 保留网站路径, 如 `API_DIR` 财务报告和审定财务报表 `STATIC_DIR`。 。 。 .

每个文件下 `src/lib` 也可以通过子路径达到,例如 `@aglyn/tenant-feature-instance/hooks/use-firestore-doc`。 。 。 .

## 使用量

```tsx
import {
  FIREBASE_CLIENT_APP_NAME,
  FirebaseServicesProvider,
  fbClientAppOptions,
  useHost,
} from '@aglyn/tenant-feature-instance'

function HostName({ hostId }: { hostId: string }) {
  const { status, data } = useHost({ hostId })
  if (status !== 'success') return null
  return <span>{data?.displayName}</span>
}

export function App() {
  return (
    <FirebaseServicesProvider
      firebaseConfig={fbClientAppOptions}
      appName={FIREBASE_CLIENT_APP_NAME}
    >
      <HostName hostId="my-host" />
    </FirebaseServicesProvider>
  )
}
```

## 怎样才合适

这是一个特色作品 `tenant` 范围。 进口 核心资源`@aglyn/aglyn`)和通用软件 `@aglyn/shared-*` 软件包。 这是 对等客户端 `@aglyn/tenant-data-admin`,它的工作同样在 带有管理员证书的服务器。 插件可能导入它; 它从不导入 插件 .

## 许可证

阿帕奇2.0 (英语). 资料来源: [https://github.com/aglyn/aglyn/tree/main/libs/tenant/feature/instance 页面存档备份,存于互联网档案馆](https://github.com/aglyn/aglyn/tree/main/libs/tenant/feature/instance)

## 常见问题

### @aglyn/tenant-feature-instance 是什么？

在Firebase网站SDK上与一个Aglyn网站实例合作的客户端-侧反向钩:Firebase服务提供商,Firestore文档和收藏钩,以及主机,屏幕,布局,组件及其版本的打入钩\. 这主要是一个

### 如何安装 @aglyn/tenant-feature-instance？

在项目目录运行 npm install @aglyn/tenant-feature-instance，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^19\.2\.8）、firebase（^13\.0\.0）、@mui/material（^9\.3\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aglyn/tenant-feature-instance 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @aglyn/tenant-feature-instance 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @aglyn/tenant-feature-instance 可以商用吗？

@aglyn/tenant-feature-instance 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @aglyn/tenant-feature-instance 的下载量有多少？

根据 npm 官方下载统计，@aglyn/tenant-feature-instance 在 2026/10/05 – 2026/11/03 这 30 天内被下载 13,382 次，日均约 446 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @aglyn/tenant-feature-instance 还在维护吗？

最新版本 1\.19\.0 发布于 2026/11/07（今天）；至今共发布 153 个版本，其中过去 12 个月发布了 153 个；首次发布于 2026/09/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。