@foir/sdk 0.30.1 → 0.31.0

package/dist/push.js

@@ -1069,7 +1069,7 @@ async function fetchFoirManifest(config, options = {}) {
 
 // src/auth/ops.ts
 var AUTH_OPS = {
-  // Pre-credential reads a login screen renders itself from.
+  // Pre-credential reads a sign-in screen renders itself from.
   authConfig: "authConfig",
   authProviders: "authProviders",
   defaultAuthProvider: "defaultAuthProvider",
@@ -1081,17 +1081,15 @@ var AUTH_OPS = {
   // they hold. `./access` reads it.
   whoami: "whoami",
   // Methods.
-  login: "login",
+  signIn: "signIn",
   register: "register",
   requestOTP: "requestOTP",
-  loginWithOTP: "loginWithOTP",
   // Session lifecycle.
   refreshToken: "refreshToken",
-  logout: "logout",
+  signOut: "signOut",
   joinWaitlist: "joinWaitlist",
   // Password management and account lifecycle.
   requestPasswordReset: "requestPasswordReset",
-  resetPassword: "resetPassword",
   updatePassword: "updatePassword",
   deleteMyAccount: "deleteMyAccount",
   // Ending their own membership where the request stands.
@@ -1105,10 +1103,10 @@ var AUTH_OPS = {
   mySessions: "mySessions",
   endMySession: "endMySession",
   signOutEverywhere: "signOutEverywhere",
-  // Their email addresses: one added is kept once the code it was sent proves it.
+  // Their email addresses: one added is kept once the code it was sent comes
+  // back on the step addMyAddress answers, on its own route (proveMyAddress).
   myAddresses: "myAddresses",
   addMyAddress: "addMyAddress",
-  proveMyAddress: "proveMyAddress",
   makeMyAddressPrimary: "makeMyAddressPrimary",
   removeMyAddress: "removeMyAddress",
   // A copy of their own data.
@@ -1119,10 +1117,8 @@ var AUTH_OPS = {
   disconnectSignInMethod: "disconnectSignInMethod",
   // Their second factors. A change needs one proven first, by a step-up.
   myFactors: "myFactors",
-  beginStepUp: "beginStepUp",
-  completeStepUp: "completeStepUp",
+  stepUp: "stepUp",
   beginFactorEnrollment: "beginFactorEnrollment",
-  completeFactorEnrollment: "completeFactorEnrollment",
   removeFactor: "removeFactor",
   renameFactor: "renameFactor",
   makeRecoveryCodes: "makeRecoveryCodes",
@@ -1136,13 +1132,7 @@ var AUTH_OPS = {
   // Founding one. Present in a manifest only when the project opted in.
   registerOrganization: "registerOrganization",
   // External identity providers.
-  loginWithProvider: "loginWithProvider",
-  providerCallback: "providerCallback",
-  providerVerifyOTP: "providerVerifyOTP",
-  // A provider sign-in that names an address somebody already holds, waiting
-  // for the code sent to it.
-  confirmProviderLink: "confirmProviderLink",
-  resendProviderLinkCode: "resendProviderLinkCode"
+  signInWithProvider: "signInWithProvider"
 };
 function authClientConfig(env, options) {
   const apiKey = resolveFoirApiKey(env);
@@ -1207,7 +1197,7 @@ var TOKEN_KEY = "foir:token";
 var REFRESH_KEY = "foir:refreshToken";
 var USER_ID_KEY = "foir:userId";
 var EMAIL_KEY = "foir:email";
-async function refreshTokens(env, refreshToken) {
+async function rotateTokens(env, refreshToken) {
   return authOp(env, AUTH_OPS.refreshToken, { refreshToken });
 }
 async function saveSession(adapter, result) {
@@ -1239,7 +1229,7 @@ async function refreshSession(adapter, env) {
   const refreshToken = await adapter.get(REFRESH_KEY) ?? null;
   if (!refreshToken) return null;
   try {
-    const result = await refreshTokens(env, refreshToken);
+    const result = await rotateTokens(env, refreshToken);
     await saveSession(adapter, result);
     return { token: result.token, refreshToken: result.refreshToken };
   } catch {

package/dist/react/FoirProvider.d.ts

@@ -1,6 +1,6 @@
 import type { ReactNode } from 'react';
-import type { AuthProviderPublic, FoirAccess, FoirUser, FoirSessionConfig, HostedLoginOptions, SessionAdapter } from '../auth';
-import type { ProviderCallbackInput, ProviderLoginInput } from '../auth';
+import type { AuthProviderPublic, FoirAccess, FoirUser, FoirSessionConfig, HostedSignInOptions, SessionAdapter } from '../auth';
+import type { ProviderCallbackInput, ProviderSignInInput } from '../auth';
 import type { FoirEnv } from '../graphql/foir-request';
 /** Where the session hydration stands. */
 export type FoirStatus = 'loading' | 'authenticated' | 'unauthenticated';
@@ -32,21 +32,25 @@ export interface FoirContextValue {
      * Start a sign-up: the address is mailed a code, and `signInWithOtp` with it
      * finishes the account and signs them in.
      */
-    register(vars: {
+    signUp(vars: {
         email: string;
         password: string;
     }): Promise<void>;
+    /** Email the address a code to sign in with; `signInWithOtp` brings it back. */
     requestOtp(email: string): Promise<boolean>;
+    /**
+     * Bring back the code the address was last sent by `requestOtp` or
+     * `signUp`, to the step that sent it, and sign them in.
+     */
     signInWithOtp(vars: {
         email: string;
         otp: string;
     }): 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<FoirUser>;
+    /** Start a provider (OAuth/OIDC) sign-in. Redirect providers navigate away. */
+    signInWithProvider(providerKey: string, opts?: Omit<ProviderSignInInput, 'providerKey'>): Promise<void>;
+    /** Finish a provider sign-in on your callback route (code + state). */
+    finishProviderSignIn(input: ProviderCallbackInput): Promise<FoirUser>;
+    /** End the session on the platform and here. */
     signOut(): Promise<void>;
     /** Rotate the access token; returns false (and signs out) if it can't. */
     refresh(): Promise<boolean>;
@@ -60,7 +64,7 @@ export interface FoirContextValue {
      * where you call {@link FoirContextValue.signIn} instead. `options.org` names
      * the organization the sign-in is for.
      */
-    hostedSignInUrl: ((returnTo?: string, options?: HostedLoginOptions) => string) | null;
+    hostedSignInUrl: ((returnTo?: string, options?: HostedSignInOptions) => string) | null;
 }
 export interface FoirProviderProps {
     /** API config: `{ PLATFORM_API_URL, PLATFORM_API_KEY }` (a publishable key). */
@@ -139,7 +143,7 @@ export declare function useFoirAuth(): {
         email: string;
         password: string;
     }) => Promise<FoirUser>;
-    register: (vars: {
+    signUp: (vars: {
         email: string;
         password: string;
     }) => Promise<void>;
@@ -148,13 +152,11 @@ export declare function useFoirAuth(): {
         email: string;
         otp: string;
     }) => Promise<FoirUser>;
-    signInWithProvider: (providerKey: string, opts?: Omit<ProviderLoginInput, "providerKey">) => Promise<void>;
-    completeProviderLogin: (input: Omit<ProviderCallbackInput, "providerKey"> & {
-        providerKey: string;
-    }) => Promise<FoirUser>;
+    signInWithProvider: (providerKey: string, opts?: Omit<ProviderSignInInput, "providerKey">) => Promise<void>;
+    finishProviderSignIn: (input: ProviderCallbackInput) => Promise<FoirUser>;
     signOut: () => Promise<void>;
     refresh: () => Promise<boolean>;
     getToken: () => Promise<string | null>;
     getProviders: () => Promise<AuthProviderPublic[]>;
-    hostedSignInUrl: ((returnTo?: string, options?: HostedLoginOptions) => string) | null;
+    hostedSignInUrl: ((returnTo?: string, options?: HostedSignInOptions) => string) | null;
 };

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

@@ -54,8 +54,7 @@ interface FoirGeneratedFeedbackClient {
          * optional. Screenshot capture is the only thing that reaches it.
          */
         readonly files?: {
-            createFileUpload(args?: Record<string, unknown>): Promise<unknown>;
-            confirmFileUpload(args?: Record<string, unknown>): Promise<unknown>;
+            uploadFile(args?: Record<string, unknown>): Promise<unknown>;
         };
     };
 }