@stackframe/stack 2.4.23 → 2.4.25

package/dist/lib/stack-app.d.ts

@@ -1,5 +1,5 @@
-import { ServerUserJson, OAuthProviderConfigJson, KnownErrors } from '@stackframe/stack-shared';
-import { StandardProvider, UserJson, UserUpdateJson, ProjectJson, ProductionModeError, TeamJson, EmailConfigJson, DomainConfigJson, ClientProjectJson } from '@stackframe/stack-shared/dist/interface/clientInterface';
+import { KnownErrors, ServerUserJson, OAuthProviderConfigJson } from '@stackframe/stack-shared';
+import { StandardProvider, UserUpdateJson, UserJson, ProjectJson, ProductionModeError, TeamJson, EmailConfigJson, DomainConfigJson, ClientProjectJson } from '@stackframe/stack-shared/dist/interface/clientInterface';
 import { ReadonlyJson } from '@stackframe/stack-shared/dist/utils/json';
 import { ProjectUpdateOptions, ApiKeySetCreateOptions } from '@stackframe/stack-shared/dist/interface/adminInterface';
 import { ServerUserUpdateJson, ServerTeamCustomizableJson, ServerPermissionDefinitionCustomizableJson, ServerPermissionDefinitionJson, EmailTemplateType } from '@stackframe/stack-shared/dist/interface/serverInterface';
@@ -36,6 +36,7 @@ type OAuthScopesOnSignIn = {
     [key in StandardProvider]: string[];
 };
 type ProjectCurrentUser<ProjectId> = ProjectId extends "internal" ? CurrentInternalUser : CurrentUser;
+type ProjectCurrentServerUser<ProjectId> = ProjectId extends "internal" ? CurrentInternalServerUser : CurrentServerUser;
 type StackClientAppConstructorOptions<HasTokenStore extends boolean, ProjectId extends string> = {
     baseUrl?: string;
     projectId?: ProjectId;
@@ -68,10 +69,10 @@ type Session = {
 /**
  * Contains everything related to the current user session.
  */
-type Auth<T, C> = {
+type Auth = {
     readonly _internalSession: InternalSession;
     readonly currentSession: Session;
-    signOut(this: T): Promise<void>;
+    signOut(): Promise<void>;
     /**
      * Returns headers for sending authenticated HTTP requests to external servers. Most commonly used in cross-origin
      * requests. Similar to `getAuthJson`, but specifically for HTTP requests.
@@ -143,26 +144,12 @@ type Auth<T, C> = {
         accessToken: string | null;
         refreshToken: string | null;
     }>;
-    update(this: T, user: C): Promise<void>;
-    updateSelectedTeam(this: T, team: Team | null): Promise<void>;
-    sendVerificationEmail(this: T): Promise<KnownErrors["EmailAlreadyVerified"] | void>;
-    updatePassword(this: T, options: {
-        oldPassword: string;
-        newPassword: string;
-    }): Promise<KnownErrors["PasswordMismatch"] | KnownErrors["PasswordRequirementsNotMet"] | void>;
 };
-type InternalAuth<T> = {
-    createProject(this: T, newProject: ProjectUpdateOptions & {
-        displayName: string;
-    }): Promise<Project>;
-    listOwnedProjects(this: T): Promise<Project[]>;
-    useOwnedProjects(this: T): Project[];
-    onOwnedProjectsChange(this: T, callback: (projects: Project[]) => void): void;
-};
-type User = ({
+type User = {
     readonly projectId: string;
     readonly id: string;
     readonly displayName: string | null;
+    setDisplayName(displayName: string): Promise<void>;
     /**
      * The user's email address.
      *
@@ -170,71 +157,87 @@ type User = ({
      */
     readonly primaryEmail: string | null;
     readonly primaryEmailVerified: boolean;
+    sendVerificationEmail(): Promise<KnownErrors["EmailAlreadyVerified"] | void>;
     readonly profileImageUrl: string | null;
     readonly signedUpAt: Date;
     readonly clientMetadata: ReadonlyJson;
-    readonly authMethod: 'credential' | 'oauth';
-    readonly hasPassword: boolean;
+    setClientMetadata(metadata: ReadonlyJson): Promise<void>;
+    /**
+     * Whether the primary e-mail can be used for authentication.
+     */
     readonly authWithEmail: boolean;
+    /**
+     * Whether the user has a password set.
+     */
+    readonly hasPassword: boolean;
     readonly oauthProviders: readonly string[];
-    hasPermission(this: CurrentUser, scope: Team, permissionId: string): Promise<boolean>;
-    getSelectedTeam(this: CurrentUser): Promise<Team | null>;
-    useSelectedTeam(this: CurrentUser): Team | null;
-    getConnection(id: StandardProvider, options?: {
-        scopes?: string[];
-    }): Promise<OAuthConnection | null>;
-    getConnection(id: StandardProvider, options: {
+    updatePassword(options: {
+        oldPassword: string;
+        newPassword: string;
+    }): Promise<KnownErrors["PasswordMismatch"] | KnownErrors["PasswordRequirementsNotMet"] | void>;
+    /**
+     * A shorthand method to update multiple fields of the user at once.
+     */
+    update(update: UserUpdateJson): Promise<void>;
+    hasPermission(scope: Team, permissionId: string): Promise<boolean>;
+    readonly selectedTeam: Team | null;
+    setSelectedTeam(team: Team | null): Promise<void>;
+    getConnectedAccount(id: StandardProvider, options: {
         or: 'redirect';
         scopes?: string[];
     }): Promise<OAuthConnection>;
-    getConnection(id: StandardProvider, options?: {
-        or?: 'redirect';
+    getConnectedAccount(id: StandardProvider, options?: {
+        or?: 'redirect' | 'throw' | 'return-null';
         scopes?: string[];
     }): Promise<OAuthConnection | null>;
-    useConnection(id: StandardProvider, options?: {
-        scopes?: string[];
-    }): OAuthConnection | null;
-    useConnection(id: StandardProvider, options: {
+    useConnectedAccount(id: StandardProvider, options: {
         or: 'redirect';
         scopes?: string[];
     }): OAuthConnection;
-    useConnection(id: StandardProvider, options?: {
-        or?: 'redirect';
+    useConnectedAccount(id: StandardProvider, options?: {
+        or?: 'redirect' | 'throw' | 'return-null';
         scopes?: string[];
     }): OAuthConnection | null;
-    toJson(this: CurrentUser): UserJson;
-} & AsyncStoreProperty<"team", [id: string], Team | null, false> & AsyncStoreProperty<"teams", [], Team[], true> & Omit<AsyncStoreProperty<"permission", [scope: Team, permissionId: string, options?: {
+    toClientJson(): UserJson;
+} & AsyncStoreProperty<"team", [id: string], Team | null, false> & AsyncStoreProperty<"teams", [], Team[], true> & AsyncStoreProperty<"permission", [scope: Team, permissionId: string, options?: {
     direct?: boolean;
-}], Permission | null, false>, "onPermissionChange"> & Omit<AsyncStoreProperty<"permissions", [scope: Team, options?: {
+}], Permission | null, false> & AsyncStoreProperty<"permissions", [scope: Team, options?: {
     direct?: boolean;
-}], Permission[], true>, "onPermissionsChange">);
-type CurrentUser = Auth<User, UserUpdateJson> & User;
-type CurrentInternalUser = CurrentUser & InternalAuth<CurrentUser>;
+}], Permission[], true>;
+type InternalUserExtra = {
+    createProject(newProject: ProjectUpdateOptions & {
+        displayName: string;
+    }): Promise<Project>;
+} & AsyncStoreProperty<"ownedProjects", [], Project[], true>;
+type CurrentUser = Auth & User;
+type CurrentInternalUser = CurrentUser & InternalUserExtra;
 /**
  * A user including sensitive fields that should only be used on the server, never sent to the client
  * (such as sensitive information and serverMetadata).
  */
-type ServerUser = (Omit<User, 'hasPermission' | 'toJson' | keyof AsyncStoreProperty<"team", [], Team | null, false> | keyof AsyncStoreProperty<"teams", [], Team[], true> | keyof AsyncStoreProperty<"permission", [], Permission[], false> | keyof AsyncStoreProperty<"permissions", [], Permission[], true>> & {
+type ServerUser = {
+    setPrimaryEmail(email: string, options?: {
+        verified?: boolean | undefined;
+    }): Promise<void>;
     readonly serverMetadata: ReadonlyJson;
-    /**
-     * Returns a new user object with the sensitive fields removed.
-     */
-    getClientUser(this: ServerUser): User;
-    update(this: ServerUser, user: Partial<ServerUserUpdateJson>): Promise<void>;
-    delete(this: ServerUser): Promise<void>;
+    setServerMetadata(metadata: ReadonlyJson): Promise<void>;
+    updatePassword(options: {
+        oldPassword?: string;
+        newPassword: string;
+    }): Promise<KnownErrors["PasswordMismatch"] | KnownErrors["PasswordRequirementsNotMet"] | void>;
+    update(user: Partial<ServerUserUpdateJson>): Promise<void>;
+    delete(): Promise<void>;
     grantPermission(scope: Team, permissionId: string): Promise<void>;
     revokePermission(scope: Team, permissionId: string): Promise<void>;
     hasPermission(scope: Team, permissionId: string): Promise<boolean>;
-    toJson(this: ServerUser): ServerUserJson;
-} & AsyncStoreProperty<"team", [id: string], ServerTeam | null, false> & AsyncStoreProperty<"teams", [], ServerTeam[], true> & Omit<AsyncStoreProperty<"permission", [scope: Team, permissionId: string, options?: {
+    toServerJson(): ServerUserJson;
+} & AsyncStoreProperty<"team", [id: string], ServerTeam | null, false> & AsyncStoreProperty<"teams", [], ServerTeam[], true> & AsyncStoreProperty<"permission", [scope: Team, permissionId: string, options?: {
     direct?: boolean;
-}], ServerPermission | null, false>, "onPermissionChange"> & Omit<AsyncStoreProperty<"permissions", [scope: Team, options?: {
+}], ServerPermission | null, false> & AsyncStoreProperty<"permissions", [scope: Team, options?: {
     direct?: boolean;
-}], ServerPermission[], true>, "onPermissionsChange">);
-type CurrentServerUser = Auth<ServerUser, ServerUserUpdateJson> & Omit<ServerUser, "getClientUser"> & {
-    getClientUser(this: CurrentServerUser): CurrentUser;
-};
-type CurrentInternalServerUser = CurrentServerUser & InternalAuth<CurrentServerUser>;
+}], ServerPermission[], true> & User;
+type CurrentServerUser = Auth & ServerUser;
+type CurrentInternalServerUser = CurrentServerUser & InternalUserExtra;
 type Project = {
     readonly id: string;
     readonly displayName: string;
@@ -260,7 +263,7 @@ type Team = {
     id: string;
     displayName: string;
     createdAt: Date;
-    toJson(this: Team): TeamJson;
+    toJson(): TeamJson;
 };
 type ServerTeam = Team & {
     listMembers(): Promise<ServerTeamMember[]>;
@@ -276,7 +279,7 @@ type TeamMember = {
     displayName: string | null;
 };
 type ServerTeamMember = TeamMember & {
-    getUser(): Promise<ServerUser>;
+    user: ServerUser;
 };
 type Permission = {
     id: string;
@@ -331,14 +334,14 @@ type ApiKeySet = ApiKeySetBase & {
 type EmailConfig = EmailConfigJson;
 type DomainConfig = DomainConfigJson;
 type OAuthProviderConfig = OAuthProviderConfigJson;
-type GetUserOptions = {
+type GetUserOptions<HasTokenStore> = {
     or?: 'redirect' | 'throw' | 'return-null';
     tokenStore?: TokenStoreInit;
-};
+} & (HasTokenStore extends false ? {
+    tokenStore: TokenStoreInit;
+} : {});
 type AsyncStoreProperty<Name extends string, Args extends any[], Value, IsMultiple extends boolean> = {
     [key in `${IsMultiple extends true ? "list" : "get"}${Capitalize<Name>}`]: (...args: Args) => Promise<Value>;
-} & {
-    [key in `on${Capitalize<Name>}Change`]: (...tupleArgs: [...args: Args, callback: (value: Value) => void]) => void;
 } & {
     [key in `use${Capitalize<Name>}`]: (...args: Args) => Value;
 };
@@ -371,36 +374,34 @@ type StackClientApp<HasTokenStore extends boolean = boolean, ProjectId extends s
     verifyPasswordResetCode(code: string): Promise<KnownErrors["PasswordResetCodeError"] | void>;
     verifyEmail(code: string): Promise<KnownErrors["EmailVerificationError"] | void>;
     signInWithMagicLink(code: string): Promise<KnownErrors["MagicLinkError"] | void>;
-    [stackAppInternalsSymbol]: {
-        toClientJson(): StackClientAppJson<HasTokenStore, ProjectId>;
-        setCurrentUser(userJsonPromise: Promise<UserJson | null>): void;
-    };
-} & AsyncStoreProperty<"project", [], ClientProjectJson, false> & {
-    [K in `redirectTo${Capitalize<keyof Omit<HandlerUrls, 'handler' | 'oauthCallback'>>}`]: (options?: RedirectToOptions) => Promise<void>;
-} & (HasTokenStore extends false ? {} : {
     redirectToOAuthCallback(): Promise<void>;
-    useUser(options: GetUserOptions & {
+    useUser(options: GetUserOptions<HasTokenStore> & {
         or: 'redirect';
     }): ProjectCurrentUser<ProjectId>;
-    useUser(options: GetUserOptions & {
+    useUser(options: GetUserOptions<HasTokenStore> & {
         or: 'throw';
     }): ProjectCurrentUser<ProjectId>;
-    useUser(options?: GetUserOptions): ProjectCurrentUser<ProjectId> | null;
-    getUser(options: GetUserOptions & {
+    useUser(options?: GetUserOptions<HasTokenStore>): ProjectCurrentUser<ProjectId> | null;
+    getUser(options: GetUserOptions<HasTokenStore> & {
         or: 'redirect';
     }): Promise<ProjectCurrentUser<ProjectId>>;
-    getUser(options: GetUserOptions & {
+    getUser(options: GetUserOptions<HasTokenStore> & {
         or: 'throw';
     }): Promise<ProjectCurrentUser<ProjectId>>;
-    getUser(options?: GetUserOptions): Promise<ProjectCurrentUser<ProjectId> | null>;
-    onUserChange: AsyncStoreProperty<"user", [], CurrentUser | null, false>["onUserChange"];
-}));
+    getUser(options?: GetUserOptions<HasTokenStore>): Promise<ProjectCurrentUser<ProjectId> | null>;
+    [stackAppInternalsSymbol]: {
+        toClientJson(): StackClientAppJson<HasTokenStore, ProjectId>;
+        setCurrentUser(userJsonPromise: Promise<UserJson | null>): void;
+    };
+} & AsyncStoreProperty<"project", [], ClientProjectJson, false> & {
+    [K in `redirectTo${Capitalize<keyof Omit<HandlerUrls, 'handler' | 'oauthCallback'>>}`]: (options?: RedirectToOptions) => Promise<void>;
+});
 declare const StackClientApp: StackClientAppConstructor;
 type StackServerAppConstructor = {
     new <TokenStoreType extends string, HasTokenStore extends (TokenStoreType extends {} ? true : boolean), ProjectId extends string>(options: StackServerAppConstructorOptions<HasTokenStore, ProjectId>): StackServerApp<HasTokenStore, ProjectId>;
     new (options: StackServerAppConstructorOptions<boolean, string>): StackServerApp<boolean, string>;
 };
-type StackServerApp<HasTokenStore extends boolean = boolean, ProjectId extends string = string> = (StackClientApp<HasTokenStore, ProjectId> & {
+type StackServerApp<HasTokenStore extends boolean = boolean, ProjectId extends string = string> = ({
     createTeam(data: ServerTeamCustomizableJson): Promise<ServerTeam>;
     createPermissionDefinition(data: ServerPermissionDefinitionCustomizableJson): Promise<ServerPermission>;
     updatePermissionDefinition(permissionId: string, data: Partial<ServerPermissionDefinitionCustomizableJson>): Promise<void>;
@@ -411,7 +412,25 @@ type StackServerApp<HasTokenStore extends boolean = boolean, ProjectId extends s
     listEmailTemplates(): Promise<ListEmailTemplatesCrud['Server']['Read']>;
     updateEmailTemplate(type: EmailTemplateType, data: EmailTemplateCrud['Server']['Update']): Promise<void>;
     resetEmailTemplate(type: EmailTemplateType): Promise<void>;
-} & AsyncStoreProperty<"serverUser", [], CurrentServerUser | null, false> & AsyncStoreProperty<"serverUsers", [], ServerUser[], true> & Omit<AsyncStoreProperty<"team", [id: string], ServerTeam | null, false>, "onTeamChange"> & Omit<AsyncStoreProperty<"teams", [], ServerTeam[], true>, "onTeamsChange">);
+    /**
+     * @deprecated use `getUser()` instead
+     */
+    getServerUser(): Promise<ProjectCurrentServerUser<ProjectId> | null>;
+    useUser(options: GetUserOptions<HasTokenStore> & {
+        or: 'redirect';
+    }): ProjectCurrentServerUser<ProjectId>;
+    useUser(options: GetUserOptions<HasTokenStore> & {
+        or: 'throw';
+    }): ProjectCurrentServerUser<ProjectId>;
+    useUser(options?: GetUserOptions<HasTokenStore>): ProjectCurrentServerUser<ProjectId> | null;
+    getUser(options: GetUserOptions<HasTokenStore> & {
+        or: 'redirect';
+    }): Promise<ProjectCurrentServerUser<ProjectId>>;
+    getUser(options: GetUserOptions<HasTokenStore> & {
+        or: 'throw';
+    }): Promise<ProjectCurrentServerUser<ProjectId>>;
+    getUser(options?: GetUserOptions<HasTokenStore>): Promise<ProjectCurrentServerUser<ProjectId> | null>;
+} & StackClientApp<HasTokenStore, ProjectId> & AsyncStoreProperty<"users", [], ServerUser[], true> & AsyncStoreProperty<"team", [id: string], ServerTeam | null, false> & AsyncStoreProperty<"teams", [], ServerTeam[], true>);
 declare const StackServerApp: StackServerAppConstructor;
 type StackAdminAppConstructor = {
     new <HasTokenStore extends boolean, ProjectId extends string>(options: StackAdminAppConstructorOptions<HasTokenStore, ProjectId>): StackAdminApp<HasTokenStore, ProjectId>;