Extension Core Infrastructure

作者 caffeinelabs362f51ae96f0无许可证2 个星标收录于 2026年10月8日更新于 2026年10月8日仓库今天更新

Core infrastructure providing backend connection configuration, storage client, and React app entry point.

AI 生成的概览

说明 Caffeine AI 应用的核心基础设施包:认证钩子、后端 actor 钩子以及应用入口配置。

功能
该技能是 @caffeineai/core-infrastructure 包的参考文档,供 Caffeine AI 项目使用。它说明如何用 InternetIdentityProvider 和 QueryClientProvider 包裹应用,useInternetIdentity() 钩子如何提供身份状态、登录方式(普通 Internet Identity、Google、Microsoft、企业 SSO)与登出,以及 useActor() 钩子如何创建并刷新带类型的后端 actor。文档还介绍用于视觉验收的模拟后端选项,以及各主要版本之间的迁移说明。
适用场景
在为 Caffeine AI 前端接入认证或后端 actor 访问时使用,也适合查阅登录行为、会话生命周期和登录按钮的限制。跨主要版本升级该包时同样适用。
运行要求
需要 npm 包 @caffeineai/core-infrastructure、@caffeineai/object-storage、@icp-sdk/auth 和 @icp-sdk/core,宿主应用还需 React 与 @tanstack/react-query。该技能不附带脚本,仅包含说明与迁移文档。

Core Infrastructure

Core infrastructure extension for Caffeine AI.

Overview

This component provides the foundational infrastructure for all projects: backend connection configuration, Internet Identity authentication hooks, and actor management utilities.

Requirements

"@caffeineai/core-infrastructure": "^2.0.0""@caffeineai/object-storage": "^1.1.0""@icp-sdk/auth": "^9.0.0""@icp-sdk/core": "^5.3.0"

@caffeineai/object-storage is a peer dependency of core-infrastructure. Every project must install it as a direct npm dependency (the build template includes both packages).

Integration

Core infrastructure is automatically included in every project. No manual integration steps are required.

Frontend

The core-infrastructure frontend package (@caffeineai/core-infrastructure) is automatically included in every project.

App Entry Point

Wrap the app with InternetIdentityProvider and QueryClientProvider:

typescript
import { InternetIdentityProvider } from "@caffeineai/core-infrastructure";import { QueryClient, QueryClientProvider } from "@tanstack/react-query";import ReactDOM from "react-dom/client";import App from "./App";
const queryClient = new QueryClient();
ReactDOM.createRoot(document.getElementById("root")!).render(  <QueryClientProvider client={queryClient}>    <InternetIdentityProvider>      <App />    </InternetIdentityProvider>  </QueryClientProvider>,);

useInternetIdentity() — Authentication Hook

Provides identity state, login, and logout for Internet Identity.

Return Values

FieldTypeDescription
identityIdentity | undefinedThe user's identity (available after login or session restore)
login(options?: LoginOptions) => voidOpens the II popup. Fire-and-forget — do not await. See Sign-in variants.
clear() => voidLogs out and clears stored identity. Fire-and-forget.
isAuthenticatedbooleantrue when user has a valid identity. Use this for UI gating.
isInitializingbooleantrue while AuthClient is loading from IndexedDB
isLoggingInbooleantrue while the II popup is open
isLoginSuccessbooleantrue only after interactive login (NOT after page reload restore)
isLoginErrorbooleantrue if login or initialization failed
isSessionExpiredbooleantrue when the session ended (idle / TTL / provider revoke), not a deliberate logout
loginErrorError | undefinedThe error object when isLoginError is true

Auth State Lifecycle

ScenariologinStatusisAuthenticated
Page load, no stored session"idle"false
Restoring stored session"initializing"false → true
Stored session restored after reload"idle"true
Interactive login in progress"logging-in"false
Interactive login just completed"success"true
Login popup failed / cancelled"loginError"false
Session expired (idle / TTL / revoke)"expired"false
Sign-out in another tab"idle"false

IMPORTANT: isLoginSuccess is only true after an interactive login via the popup — NOT when a stored identity is restored on page reload. Always use isAuthenticated for conditional rendering.

Auth state is stored, not held on the client instance: sign in or out in one tab and the others follow. A session that expires (isSessionExpired) is not a deliberate logout — show a session-ended screen rather than the signed-out landing page.

Usage

Gate authenticated UI on isAuthenticated:

typescript
const { isAuthenticated } = useInternetIdentity();
{isAuthenticated ? <AuthenticatedApp /> : <LoginScreen />}

Disable the login button while initializing or logging in:

typescript
const { login, isInitializing, isLoggingIn } = useInternetIdentity();
<button onClick={() => login()} disabled={isInitializing || isLoggingIn}>  Sign in</button>

login() and clear() are fire-and-forget — the hook's state fields (isLoggingIn, isInitializing) track the async lifecycle. Do not wrap them in local useState / isPending logic.

Sign-in variants: plain II, Google, Microsoft, workspace SSO

login() accepts an optional LoginOptions object selecting how the user signs in. All variants go through Internet Identity and produce the same identity, session behavior, and logout — they only change which screen the user sees first:

typescript
login();                            // Plain Internet Identity sign-inlogin({ provider: "google" });      // One-click Google sign-in (II opens Google OAuth directly)login({ provider: "microsoft" });   // One-click Microsoft sign-in (II opens Microsoft OAuth directly)login({ ssoDomain: "acme.com" });   // Company/workspace SSO via the domain's identity provider
  • Google: no Google API keys or OAuth client setup is needed — Internet Identity handles the OAuth flow.
  • Microsoft: no Azure/Entra app registration is needed — Internet Identity owns the OAuth client. Accepts both personal Microsoft accounts and work/school accounts.
  • Workspace SSO: the user enters their company domain (e.g. acme.com); Internet Identity discovers the company's OpenID Connect provider from https://<domain>/.well-known/ii-openid-configuration and signs in against it (works with Okta, Entra ID, and other OIDC providers the company has configured). Use this when the app needs a specific company's own tenant; use provider: "microsoft" for a one-click Microsoft button that needs no per-company setup.
  • Apple sign-in is not offered: Internet Identity returns no email or name claims for Apple, so the attribute callback would be empty.
  • Sessions from all variants are stored the same way: isAuthenticated, session restore on reload, and clear() behave identically regardless of the variant used.
  • When the backend uses caffeineai-authorization, Google, Microsoft, and SSO sign-ins carry verified name/email attributes (and the SSO domain) to the attribute callback automatically — see the extension-authorization skill.

Call login() only from a button's onClick handler. The Internet Identity popup can only be opened while a real click event is dispatching; anything else fails with Signer window should not be opened outside of click handler. In particular:

  • Never call login() from a form's onSubmit — the submit event fires after the click event has finished, so the check fails. For the SSO domain field, use a plain <div> (not a <form>) and a type="button" submit button whose onClick validates the domain and calls login({ ssoDomain }) directly.
  • Never call login() from keyboard handlers (e.g. Enter in the domain input) or after an await — both run outside the click dispatch.

If the app validates the SSO domain before calling login, mirror Internet Identity's own rules: accept a normal DNS name with at least two labels (e.g. acme.com) or a loopback host — localhost or 127.0.0.1, with an optional :port (e.g. localhost:3000). II accepts loopback domains for local testing, so the input must not reject them.

Standard sign-in UI pattern — prominent Google and Microsoft buttons, plain II sign-in, and a "company SSO" option that prompts for a domain:

typescript
function SignInOptions() {  const { login, isInitializing, isLoggingIn } = useInternetIdentity();  const [ssoDomain, setSsoDomain] = useState("");  const disabled = isInitializing || isLoggingIn;
  return (    <div>      <button onClick={() => login({ provider: "google" })} disabled={disabled}>        Continue with Google      </button>      <button onClick={() => login({ provider: "microsoft" })} disabled={disabled}>        Continue with Microsoft      </button>      <button onClick={() => login()} disabled={disabled}>        Sign in with Internet Identity      </button>      {/* Company SSO: deliberately not a <form> — login must run inside the          button's click event, and form onSubmit fires after the click ends */}      <input        value={ssoDomain}        onChange={(e) => setSsoDomain(e.target.value)}        placeholder="yourcompany.com"      />      <button        onClick={() => login({ ssoDomain: ssoDomain.trim() })}        disabled={disabled || !ssoDomain.trim()}      >        Sign in with your company      </button>    </div>  );}

Only offer the variants the app actually needs: default to plain login() unless Google, Microsoft, or company SSO sign-in was requested. When one of them is requested, the sign-in page must show the requested direct sign-in option (Google button, Microsoft button, and/or SSO domain input) and keep a plain "Sign in with Internet Identity" button as a fallback — users without a Google or Microsoft account or a registered company domain must still be able to sign in.

useActor() — Backend Actor Hook

Creates and manages a typed backend actor instance. Automatically re-creates the actor when the user's identity changes (login/logout).

typescript
import { useActor } from "@caffeineai/core-infrastructure";import { createActor } from "@/backend";
function MyComponent() {  const { actor, isFetching } = useActor(createActor);
  // actor is null while loading, then the typed backend actor  if (!actor || isFetching) return <Loading />;
  // Call backend methods directly  const data = await actor.myBackendMethod();}

Return Values

FieldTypeDescription
actorT | nullThe typed backend actor, or null while loading
isFetchingbooleantrue while the actor is being created

When the identity changes (login, logout, or session restore), the actor is automatically re-created with the new identity and all dependent queries are invalidated and refetched.

Mock backend for visual QA (VITE_USE_MOCK=true)

useActor can serve an app-owned mock instead of connecting to a canister. Put the mock at src/frontend/src/mocks/backend.ts, exporting mockBackend, and pass the glob from app source:

typescript
import { useActor } from "@caffeineai/core-infrastructure";import { createActor } from "@/backend";
const mockModules = import.meta.glob("../mocks/backend.{ts,tsx,js,jsx}");
export function useAppActor() {  return useActor(createActor, { mockModules });}

The glob has to be written in the app because Vite resolves import.meta.glob relative to the file containing the call; the package cannot see the app's mocks/ directory. Globbing rather than importing keeps the build green when the mock file does not exist. The mock is used only when VITE_USE_MOCK=true; otherwise useActor behaves exactly as before, and the real backend configuration is loaded.

Outside React, createActorWithConfig(createActor, { mockModules }) accepts the same option, and loadMockBackendFromModules(mockModules) resolves the mock on its own.

来源与署名

来源:caffeinelabs/skills位于skills/extension-core-infrastructure提交362f51a

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架