@aglyn/shared-util-fbserver

中文文档
1.19.0发布于 2026/11/07Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 1.4万

Server-side Firebase Admin bootstrap: one module that initializes the firebase-admin default app from environment variables and exposes Firestore and Auth accessors. It is mainly an internal building block of Aglyn's server-side data layer (`@aglyn/tena

原始使用文档
文档目录6 节
  1. Install
  2. What's in it
  3. It initializes on import
  4. Usage
  5. How it fits
  6. License

@aglyn/shared-util-fbserver

Server-side Firebase Admin bootstrap: one module that initializes the firebase-admin default app from environment variables and exposes Firestore and Auth accessors. It is mainly an internal building block of Aglyn's server-side data layer (@aglyn/tenant-data-admin); install it directly only if you want the same bootstrap in your own Node process.

Published to npm from the Aglyn monorepo. Versions follow semantic versioning.

Install

npm install @aglyn/shared-util-fbserver

Peer dependency: firebase-admin (^14.3.0).

What's in it

A single module, src/lib/fbserver, re-exported from the package root:

  • fbAdmin (also the default export) - a small facade over the modular Admin SDK:
    • fbAdmin.firestore(app?) returns a Firestore instance; fbAdmin.firestore.FieldValue and fbAdmin.firestore.Timestamp are the Admin SDK classes.
    • fbAdmin.auth(app?) returns the Auth service.
  • fbAdminApp - the initialized App, or undefined when initialization was skipped.
  • verifyIdToken(idToken) - verifies a Firebase ID token with revocation checking always on.
  • firestoreDatabaseId() - reads FIRESTORE_DATABASE_ID; when set, fbAdmin.firestore() targets that named database instead of (default).

It initializes on import

Importing this package runs the bootstrap. If a Firebase app already exists it is reused. Otherwise the module reads:

VariableRequiredPurpose
NEXT_PUBLIC_FIREBASE_PROJECT_IDyesproject id
FIREBASE_CLIENT_EMAILyesservice account email
FIREBASE_PRIVATE_KEYyesservice account key; literal \n sequences are converted to newlines
NEXT_PUBLIC_FIREBASE_DATABASE_URLnoRealtime Database URL
FIRESTORE_DATABASE_IDnonamed Firestore database, read at call time

If any of the three required variables is missing, initialization is skipped silently so that a build step which merely loads the module does not crash. Nothing is initialized in that case, and a later fbAdmin.firestore() or fbAdmin.auth() call fails unless you initialized a default app yourself.

package.json lists ./src/lib/fbserver.* under sideEffects. That tells bundlers the import must be kept even when nothing from it appears to be used, because the import itself is what initializes the app. For a consumer it means: this is a server-only module with an import-time effect. Never import it from code that can reach a browser bundle, and expect the app to exist (or be skipped) the moment the module loads.

Usage

import fbAdmin, { verifyIdToken } from '@aglyn/shared-util-fbserver'

const decoded = await verifyIdToken(idToken)
const snap = await fbAdmin.firestore().doc(`users/${decoded.uid}`).get()
const now = fbAdmin.firestore.Timestamp.now()

How it fits

A shared package: generic, with no knowledge of Aglyn's model, and it imports no other Aglyn package. Shared packages may only import other shared packages, and they hold no plugin's domain. In the monorepo it is consumed by @aglyn/tenant-data-admin, the Admin SDK data layer.

License

Apache-2.0. Source: https://github.com/aglyn/aglyn/tree/main/libs/shared/util/fbserver

版本与发布记录

@aglyn/shared-util-fbserver 共发布 160 个版本,首次发布于 2026/09/21;过去 12 个月发布了 160 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.19.0latest2026/11/07今天
1.18.02026/11/07今天
1.17.02026/11/07今天
1.16.02026/11/07今天
1.15.22026/11/061 天前
1.15.12026/11/061 天前

其他发布通道:beta → 1.0.0-beta.296。

关于 @aglyn/shared-util-fbserver 的常见问题

@aglyn/shared-util-fbserver 是什么?

Server-side Firebase Admin bootstrap: one module that initializes the firebase-admin default app from environment variables and exposes Firestore and Auth accessors. It is mainly an internal building block of Aglyn's server-side data layer (`@aglyn/tena

如何安装 @aglyn/shared-util-fbserver?

在项目目录运行 npm install @aglyn/shared-util-fbserver,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:firebase-admin(^14.3.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@aglyn/shared-util-fbserver 支持 TypeScript 吗?

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

@aglyn/shared-util-fbserver 支持 ESM 还是 CommonJS?

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

@aglyn/shared-util-fbserver 可以商用吗?

@aglyn/shared-util-fbserver 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@aglyn/shared-util-fbserver 的下载量有多少?

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

@aglyn/shared-util-fbserver 还在维护吗?

最新版本 1.19.0 发布于 2026/11/07(今天);至今共发布 160 个版本,其中过去 12 个月发布了 160 个;首次发布于 2026/09/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。