@casual-simulation/aux-records 3.8.1 → 3.10.2

package/AuthController.d.ts

@@ -2,12 +2,15 @@ import type { AddressType, AuthListedUserAuthenticator, AuthSession, AuthStore,
 import type { NotAuthorizedError, NotLoggedInError, NotSupportedError, ServerError } from '@casual-simulation/aux-common/Errors';
 import type { AuthMessenger } from './AuthMessenger';
 import type { RegexRule } from './Utils';
+import type { ContractFeaturesConfiguration } from './SubscriptionConfiguration';
 import type { ConfigurationStore } from './ConfigurationStore';
 import type { PrivacyFeatures, PublicUserInfo, UserRole } from '@casual-simulation/aux-common';
 import type { PrivoClientInterface, PrivoFeatureStatus, PrivoPermission, ResendConsentRequestFailure } from './PrivoClient';
 import type { PrivoConfiguration } from './PrivoConfiguration';
 import type { ZodIssue } from 'zod';
 import type { PublicKeyCredentialCreationOptionsJSON, RegistrationResponseJSON, PublicKeyCredentialRequestOptionsJSON, AuthenticationResponseJSON } from '@simplewebauthn/types';
+import type { StripeAccountStatus, StripeRequirementsStatus } from './StripeInterface';
+import type { RecordsStore } from './RecordsStore';
 /**
  * The number of miliseconds that a login request should be valid for before expiration.
  */
@@ -91,6 +94,7 @@ export interface RelyingParty {
  */
 export declare class AuthController {
     private _store;
+    private _records;
     private _messenger;
     private _config;
     private _privoClient;
@@ -98,7 +102,7 @@ export declare class AuthController {
     private _privoEnabled;
     get relyingParties(): RelyingParty[];
     set relyingParties(value: RelyingParty[]);
-    constructor(authStore: AuthStore, messenger: AuthMessenger, configStore: ConfigurationStore, privoClient?: PrivoClientInterface, relyingParties?: RelyingParty[]);
+    constructor(authStore: AuthStore, messenger: AuthMessenger, configStore: ConfigurationStore, recordsStore: RecordsStore, privoClient?: PrivoClientInterface, relyingParties?: RelyingParty[]);
     /**
      * Gets whether Privo-features are enabled.
      */
@@ -155,12 +159,33 @@ export declare class AuthController {
      * @param request The request.
      */
     getUserInfo(request: GetUserInfoRequest): Promise<GetUserInfoResult>;
+    /**
+     * Gets the user info for the given auth user.
+     *
+     * Not for public use.
+     * @param user The user to get the info for.
+     * @returns
+     */
+    getPrivateInfoForUser(user: AuthUser): Promise<GetUserInfoSuccess>;
+    private _getUserPrivoInfo;
     /**
      * Gets the public information for a specific user.
      * @param userId The ID of the user whose information is being requested.
      */
     getPublicUserInfo(userId: string): Promise<GetPublicUserInfoResult>;
     private _getSubscriptionInfo;
+    /**
+     * Gets the subscription information for a user.
+     *
+     * Not for public use.
+     * @param user The user to get the subscription information for.
+     * @returns
+     */
+    getUserSubscriptionInfo(user: AuthUser): Promise<{
+        hasActiveSubscription: boolean;
+        subscriptionId: string;
+        subscriptionTier: string;
+    }>;
     /**
      * Attempts to update a user's metadata.
      * @param request The request for the operation.
@@ -440,6 +465,22 @@ export interface LoginRequest {
      * The IP address that the login is from.
      */
     ipAddress: string;
+    /**
+     * The ID of the studio that the login is for.
+     *
+     * If null, then the user is logging into CasualOS proper.
+     */
+    loginStudioId?: string | null;
+    /**
+     * The ID of the comID that the login is for.
+     */
+    comId?: string | null;
+    /**
+     * The custom domain (i.e. hostname) that the login is for.
+     *
+     * If specified, then the hostname will be used to determine the studio/comID that the login is for.
+     */
+    customDomain?: string | null;
 }
 export type LoginRequestResult = LoginRequestSuccess | LoginRequestFailure;
 export interface LoginRequestSuccess {
@@ -475,7 +516,7 @@ export interface LoginRequestFailure {
     /**
      * The error code for the failure.
      */
-    errorCode: 'unacceptable_address' | 'unacceptable_address_type' | 'unacceptable_ip_address' | 'address_type_not_supported' | 'user_is_banned' | ServerError;
+    errorCode: 'unacceptable_address' | 'unacceptable_address_type' | 'unacceptable_ip_address' | 'unacceptable_request' | 'address_type_not_supported' | 'user_is_banned' | 'not_found' | ServerError;
     /**
      * The error message for the failure.
      */
@@ -726,17 +767,20 @@ export interface ReplaceSessionFailure {
  */
 export interface GetUserInfoRequest {
     /**
-     * The session key that should be used to authenticate the request.
+     * The ID of the currently logged in user.
      */
-    sessionKey: string;
+    userId: string;
     /**
-     * The ID of the user whose info should be retrieved.
+     * The role of the currently logged in user.
      */
-    userId: string;
+    userRole?: UserRole;
+    /**
+     * The ID of the user that should be retrieved.
+     * If omitted, then the logged in user info will be retrieved.
+     */
+    requestedUserId?: string;
 }
-export type GetUserInfoResult = GetUserInfoSuccess | GetUserInfoFailure;
-export interface GetUserInfoSuccess {
-    success: true;
+export interface UserInfo {
     /**
      * The ID of the user that was retrieved.
      */
@@ -781,10 +825,34 @@ export interface GetUserInfoSuccess {
      * The role that the user has in the system.
      */
     role: UserRole;
+    /**
+     * The contracting features that the user has access to.
+     */
+    contractFeatures?: ContractFeaturesConfiguration;
+    /**
+     * The rate at which the user is requesting payment (null if not yet specified)
+     */
+    requestedRate: number | null;
+    /**
+     * The user's connected stripe account ID.
+     */
+    stripeAccountId: string | null;
+    /**
+     * The user's connected stripe account requirements status.
+     */
+    stripeAccountRequirementsStatus: StripeRequirementsStatus | null;
+    /**
+     * The user's connected stripe account status.
+     */
+    stripeAccountStatus: StripeAccountStatus | null;
+}
+export type GetUserInfoResult = GetUserInfoSuccess | GetUserInfoFailure;
+export interface GetUserInfoSuccess extends UserInfo {
+    success: true;
 }
 export interface GetUserInfoFailure {
     success: false;
-    errorCode: 'unacceptable_user_id' | ValidateSessionKeyFailure['errorCode'] | ServerError;
+    errorCode: 'user_not_found' | NotAuthorizedError | ServerError;
     errorMessage: string;
 }
 export type GetPublicUserInfoResult = GetPublicUserInfoSuccess | GetPublicUserInfoFailure;