@fayz-ai/storefront

中文文档
0.95.1发布于 2026/11/12MITTypeScriptES Module近 30 天下载 1.2万

Fayz SDK storefront kit — Shopify-style customer-facing ecommerce template components

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

@fayz-ai/storefront

Shopify-style customer-facing storefront, assembled from data — hero, products, cart, checkout, all themeable.

npm license

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

@fayz-ai/storefront is the customer-facing surface of the Fayz SDK: a storefront scaffold that renders a page as a tree of blocks (hero, products, manifesto, cart, …) defined in the app manifest. Two completely different brands come out of the same template with zero custom components — the storefront is data, not a fork.

It reads commerce from @fayz-ai/shop, so the same engine powering an admin also powers the public store. Customize from labels to a fully bespoke section via the customization ladder — never by editing this package.

What's inside

  • Scaffold — defineStorefront(config) + StorefrontScaffold rendered by renderApp
  • Block system — registerStorefrontBlocks, sectionsToBlocks (sections as registry blocks)
  • Factory path — createStorefrontApp, initStorefrontRuntime, StorefrontShell
  • Routing — hash router (Link, navigateTo, useHashPath, matchPath)
  • Config hook — useStorefrontConfig

Install

npm install @fayz-ai/storefront

Peer deps: @fayz-ai/core, @fayz-ai/ui, @fayz-ai/shop, @fayz-ai/auth (+ react, react-dom).

Usage

import { renderApp } from '@fayz-ai/core'
import { defineStorefront } from '@fayz-ai/storefront'

export function App() {
  return renderApp(defineStorefront(config), { surface: 'storefront' })
}

Part of the Fayz SDK

The storefront surface over @fayz-ai/shop. The admin counterpart is built with @fayz-ai/admin; both are surfaces of one manifest.

Roadmap & contributing

Built and evolving in the open. See the Fayz SDK roadmap.

版本与发布记录

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

版本发布日期距今
0.95.1latest2026/11/122 天前
0.95.02026/11/122 天前
0.94.02026/11/112 天前
0.93.02026/11/113 天前
0.92.42026/11/113 天前
0.92.02026/11/113 天前

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

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

@fayz-ai/storefront 是什么?

Fayz SDK storefront kit — Shopify-style customer-facing ecommerce template components

如何安装 @fayz-ai/storefront?

在项目目录运行 npm install @fayz-ai/storefront,或使用 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)、lucide-react(>=0.400.0 <1.0.0)、@supabase/supabase-js(^2.45.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@fayz-ai/storefront 支持 TypeScript 吗?

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

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

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

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

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

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

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

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

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