@foir/sdk 0.21.0 → 0.22.0

package/dist/react/FoirProvider.d.ts

@@ -1,22 +1,22 @@
 import type { ReactNode } from 'react';
-import type { AuthProviderPublic, FoirAccess, FoirCustomer, FoirSessionConfig, SessionAdapter } from '../auth';
+import type { AuthProviderPublic, FoirAccess, FoirUser, FoirSessionConfig, SessionAdapter } from '../auth';
 import type { ProviderCallbackInput, ProviderLoginInput } from '../auth';
 import type { FoirEnv } from '../graphql/foir-request';
 /** Where the session hydration stands. */
 export type FoirStatus = 'loading' | 'authenticated' | 'unauthenticated';
 /**
- * Where reading the signed-in customer's access stands. `idle` until something
+ * Where reading the signed-in user's access stands. `idle` until something
  * asks for it; `unavailable` when the platform could not be asked.
  */
 export type FoirAccessStatus = 'idle' | 'loading' | 'ready' | 'unavailable';
 /** The full context value. Read it through the hooks below, not directly. */
 export interface FoirContextValue {
     status: FoirStatus;
-    customer: FoirCustomer | null;
-    /** The signed-in customer's access, once read. See {@link useFoirAccess}. */
+    user: FoirUser | null;
+    /** The signed-in user's access, once read. See {@link useFoirAccess}. */
     access: FoirAccess | null;
     accessStatus: FoirAccessStatus;
-    /** Ask the platform for the signed-in customer's access, again if it was read before. */
+    /** Ask the platform for the signed-in user's access, again if it was read before. */
     loadAccess(): Promise<void>;
     /** The same, unless a read is already under way: then that one is awaited. */
     ensureAccess(): Promise<void>;
@@ -27,22 +27,22 @@ export interface FoirContextValue {
     signIn(vars: {
         email: string;
         password: string;
-    }): Promise<FoirCustomer>;
+    }): Promise<FoirUser>;
     register(vars: {
         email: string;
         password: string;
-    }): Promise<FoirCustomer>;
+    }): Promise<FoirUser>;
     requestOtp(email: string): Promise<boolean>;
     signInWithOtp(vars: {
         email: string;
         otp: string;
-    }): Promise<FoirCustomer>;
+    }): Promise<FoirUser>;
     /** Start a provider (OAuth/OIDC) login. Redirect providers navigate away. */
     signInWithProvider(providerKey: string, opts?: Omit<ProviderLoginInput, 'providerKey'>): Promise<void>;
     /** Complete a provider login from your callback route (code + state). */
     completeProviderLogin(input: Omit<ProviderCallbackInput, 'providerKey'> & {
         providerKey: string;
-    }): Promise<FoirCustomer>;
+    }): Promise<FoirUser>;
     signOut(): Promise<void>;
     /** Rotate the access token; returns false (and signs out) if it can't. */
     refresh(): Promise<boolean>;
@@ -78,8 +78,8 @@ export interface FoirProviderProps {
     children: ReactNode;
 }
 /**
- * Provides Foir customer auth to a React tree. Hydrates the session on mount,
- * then exposes the current customer and sign-in/out actions through
+ * Provides Foir user auth to a React tree. Hydrates the session on mount,
+ * then exposes the current user and sign-in/out actions through
  * {@link useFoirSession}, {@link useFoirUser}, and {@link useFoirAuth}.
  *
  * Two session models:
@@ -93,14 +93,14 @@ export declare function FoirProvider({ env, adapter, hostedSession, children, }:
 /** The current session state. */
 export interface FoirSession {
     status: FoirStatus;
-    customer: FoirCustomer | null;
+    user: FoirUser | null;
     isLoading: boolean;
     isAuthenticated: boolean;
 }
-/** Read the current session status and customer. */
+/** Read the current session status and user. */
 export declare function useFoirSession(): FoirSession;
-/** The signed-in customer (`{ id, email }`), or null. */
-export declare function useFoirUser(): FoirCustomer | null;
+/** The signed-in user (`{ id, email }`), or null. */
+export declare function useFoirUser(): FoirUser | null;
 /** What {@link useFoirAccess} returns. */
 export interface FoirAccessState {
     /**
@@ -110,17 +110,17 @@ export interface FoirAccessState {
      */
     status: 'loading' | 'ready' | 'unavailable';
     isLoading: boolean;
-    /** The signed-in customer's access, or null: signed out, loading or unavailable. */
+    /** The signed-in user's access, or null: signed out, loading or unavailable. */
     access: FoirAccess | null;
-    /** Whether the customer holds the role with this key. False until known. */
+    /** Whether the user holds the role with this key. False until known. */
     hasRole(key: string): boolean;
-    /** Whether the customer's scopes cover this one. False until known. */
+    /** Whether the user's scopes cover this one. False until known. */
     hasScope(scope: string): boolean;
     /** Ask the platform again, for a role given or taken away since. */
     reload(): Promise<void>;
 }
 /**
- * The roles the signed-in customer holds and the scopes they resolve to, as the
+ * The roles the signed-in user holds and the scopes they resolve to, as the
  * platform resolved them. Read on first use, again when the session refreshes,
  * and whenever `reload` is called.
  *
@@ -133,20 +133,20 @@ export declare function useFoirAuth(): {
     signIn: (vars: {
         email: string;
         password: string;
-    }) => Promise<FoirCustomer>;
+    }) => Promise<FoirUser>;
     register: (vars: {
         email: string;
         password: string;
-    }) => Promise<FoirCustomer>;
+    }) => Promise<FoirUser>;
     requestOtp: (email: string) => Promise<boolean>;
     signInWithOtp: (vars: {
         email: string;
         otp: string;
-    }) => Promise<FoirCustomer>;
+    }) => Promise<FoirUser>;
     signInWithProvider: (providerKey: string, opts?: Omit<ProviderLoginInput, "providerKey">) => Promise<void>;
     completeProviderLogin: (input: Omit<ProviderCallbackInput, "providerKey"> & {
         providerKey: string;
-    }) => Promise<FoirCustomer>;
+    }) => Promise<FoirUser>;
     signOut: () => Promise<void>;
     refresh: () => Promise<boolean>;
     getToken: () => Promise<string | null>;

package/dist/react/SignIn.d.ts

@@ -1,4 +1,4 @@
-import type { FoirCustomer } from '../auth';
+import type { FoirUser } from '../auth';
 export interface SignInProps {
     /** `password` (default) or `otp` (email one-time code). Ignored when `hostedUrl` is set. */
     method?: 'password' | 'otp';
@@ -8,12 +8,12 @@ export interface SignInProps {
     oauth?: boolean;
     /** Navigate here after a successful sign-in. */
     afterSignInUrl?: string;
-    /** Called with the customer on a successful sign-in (before any redirect). */
-    onSignIn?(customer: FoirCustomer): void;
+    /** Called with the user on a successful sign-in (before any redirect). */
+    onSignIn?(user: FoirUser): void;
     className?: string;
 }
 /**
- * A drop-in customer sign-in. Renders an email/password (or OTP) form and,
+ * A drop-in user sign-in. Renders an email/password (or OTP) form and,
  * unless disabled, OAuth provider buttons. Set `hostedUrl` to instead render a
  * button that redirects to a hosted login page. All state is handled through
  * {@link FoirProvider}; on success it calls `onSignIn` and optionally navigates

package/dist/react/UserButton.d.ts

@@ -6,7 +6,7 @@ export interface UserButtonProps {
     className?: string;
 }
 /**
- * A minimal signed-in affordance: the customer's email plus a sign-out button.
+ * A minimal signed-in affordance: the user's email plus a sign-out button.
  * Renders nothing when signed out. Style it via `className` (the default is an
  * unopinionated inline layout).
  */

package/dist/react/feedback-notes.d.ts

@@ -7,7 +7,7 @@
  * shape (see `data/selection.ts`) — so every response here has to be read rather
  * than cast, and reading is the part worth testing on its own.
  */
-import type { FoirCustomerNote, FoirNoteConfig, FoirSubject } from '../data';
+import type { FoirUserNote, FoirNoteConfig, FoirSubject } from '../data';
 import type { FoirScreenCapture } from '../media/screen-capture';
 /**
  * The client the widget needs, and no more of it.
@@ -44,9 +44,9 @@ export interface FoirFeedbackClient {
  * widget can name.
  *
  * The distinction earns its place because the three have different audiences.
- * `signIn` is the visitor's to fix. `scope` is the OPERATOR's — a role that does
+ * `signIn` is the visitor's to fix. `scope` is the PROJECT's: a role that does
  * not grant `notes:create` produces `missing required scope: notes:create`, which
- * reads like a bad API key and is not one; the key is fine and the customer's
+ * reads like a bad API key and is not one; the key is fine and the user's
  * role is short a capability. `other` is everything the widget will not pretend
  * to understand.
  */
@@ -98,4 +98,4 @@ export interface FoirFeedbackSubmission {
  * worse than one that did not arrive: they have no way to tell, and the thing
  * they wrote ("as you can see in the screenshot") stops making sense.
  */
-export declare function submitFeedbackNote(client: FoirFeedbackClient, submission: FoirFeedbackSubmission): Promise<FoirCustomerNote>;
+export declare function submitFeedbackNote(client: FoirFeedbackClient, submission: FoirFeedbackSubmission): Promise<FoirUserNote>;

package/dist/react/index.d.ts

@@ -1,8 +1,8 @@
 /**
- * `@foir/sdk/react` — drop-in React components for Foir customers.
+ * `@foir/sdk/react` — drop-in React components for Foir users.
  *
  * Wrap your app in `<FoirProvider>`, then read the session with
- * `useFoirSession` / `useFoirUser`, ask what the customer may see with
+ * `useFoirSession` / `useFoirUser`, ask what the user may see with
  * `useFoirAccess`, and drive it with `useFoirAuth` — or drop in
  * the `<SignIn>`, `<OAuthButtons>`, and `<UserButton>` components. Built entirely
  * on `@foir/sdk/auth`; `react` is the only peer dependency.
@@ -22,5 +22,5 @@ export type { UserButtonProps } from './UserButton';
 export { FoirFeedback } from './FoirFeedback';
 export type { FoirFeedbackProps, FoirFeedbackClient } from './FoirFeedback';
 export { createLocalStorageAdapter } from './localStorageAdapter';
-export type { FoirAccess, FoirCustomer, SessionAdapter, AuthProviderPublic } from '../auth';
+export type { FoirAccess, FoirUser, SessionAdapter, AuthProviderPublic } from '../auth';
 export type { FoirEnv } from '../graphql/foir-request';