@fayz-ai/portal

中文文档
0.94.0发布于 2026/11/11MITTypeScriptES Module近 30 天下载 5013

Fayz SDK member/learner portal scaffold — authenticated 'my courses' + player surface

原始使用文档
文档目录4 节
  1. What's inside
  2. Install
  3. Usage
  4. Part of the Fayz SDK

@fayz-ai/portal

The authenticated member/learner portal scaffold — a "my courses" + player surface for your students.

npm license

Status: beta — published to npm and used across Fayz dogfood apps. Pre-1.0: minor APIs may change before 1.0.

Every course or membership product needs a second front door: not the admin app the creator uses, but the logged-in space their members live in. @fayz-ai/portal is that surface — an opinionated, auth-gated member shell that renders "my courses," a lesson player, and an account page on top of @fayz-ai/courses and @fayz-ai/auth. Compose it once and your learners get a real portal instead of a hand-wired one.

What's inside

  • Member app runtime — createMemberApp, initMemberRuntime, and the MemberShell layout (header + routed content)
  • Scaffold — defineMember / MemberScaffold to declare the portal as data
  • Pages — MyCoursesPage, CoursePlayerPage, AccountPage, and a MemberHeader
  • Session + config — useMemberSession, MemberConfigProvider / useMemberConfig, and a hash router (useHashPath, Link, navigateTo)

Install

npm install @fayz-ai/portal

Peer deps: react, react-dom (^18 or ^19). Runtime deps include @fayz-ai/core, @fayz-ai/auth, and @fayz-ai/courses.

Usage

import { createMemberApp } from '@fayz-ai/portal'

export const memberApp = createMemberApp({
  // auth + courses config for the logged-in learner surface
})

Part of the Fayz SDK

The learner-facing half of the courses stack. Pairs with @fayz-ai/courses (the course model + admin) and @fayz-ai/auth (who's logged in).

版本与发布记录

@fayz-ai/portal 共发布 63 个版本,首次发布于 2026/06/24;过去 12 个月发布了 63 个版本。

版本发布日期距今
0.94.0latest2026/11/112 天前
0.92.02026/11/113 天前
0.90.02026/11/068 天前
0.79.02026/11/059 天前
0.78.02026/11/0410 天前
0.77.02026/10/3015 天前

其他发布通道:next → 0.9.0-next.1,canary → 0.76.0-canary.20261028153856。

关于 @fayz-ai/portal 的常见问题

@fayz-ai/portal 是什么?

Fayz SDK member/learner portal scaffold — authenticated 'my courses' + player surface

如何安装 @fayz-ai/portal?

在项目目录运行 npm install @fayz-ai/portal,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.0.0)、zustand(^4.5.0 || ^5.0.0)、react-dom(^18.0.0 || ^19.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@fayz-ai/portal 支持 TypeScript 吗?

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

@fayz-ai/portal 支持 ESM 还是 CommonJS?

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

@fayz-ai/portal 可以商用吗?

@fayz-ai/portal 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@fayz-ai/portal 的下载量有多少?

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

@fayz-ai/portal 还在维护吗?

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