@axcode/axcloud-sdk 0.1.7-dev.580a922 → 0.1.7-dev.bf490b9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +200 -124
- package/dist/index.d.mts +78 -3
- package/dist/index.d.ts +78 -3
- package/dist/index.js +339 -42
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +334 -44
- package/dist/index.mjs.map +1 -1
- package/package.json +5 -1
package/dist/index.d.mts
CHANGED
|
@@ -93,12 +93,57 @@ declare class AxCloudError extends Error {
|
|
|
93
93
|
}
|
|
94
94
|
declare function isAxCloudError(error: unknown): error is AxCloudError;
|
|
95
95
|
|
|
96
|
+
type AnalyticsEventValue = string | number | boolean;
|
|
97
|
+
type AnalyticsEventData = Record<string, AnalyticsEventValue>;
|
|
98
|
+
interface AxCloudAnalyticsOptions {
|
|
99
|
+
/** Site key configured in AxCloud, for example "public-web". */
|
|
100
|
+
siteKey: string;
|
|
101
|
+
/** Analytics is opt-in and disabled unless this is true. */
|
|
102
|
+
enabled?: boolean;
|
|
103
|
+
/** Allow local collection for explicit development tests. */
|
|
104
|
+
trackLocalhost?: boolean;
|
|
105
|
+
/** Override path normalization. Return null to skip a pageview. */
|
|
106
|
+
normalizePath?: (pathname: string) => string | null;
|
|
107
|
+
}
|
|
108
|
+
interface AnalyticsPublicConfig {
|
|
109
|
+
enabled: boolean;
|
|
110
|
+
provider?: 'umami';
|
|
111
|
+
websiteId?: string;
|
|
112
|
+
scriptUrl?: string;
|
|
113
|
+
hostUrl?: string;
|
|
114
|
+
domains?: string[];
|
|
115
|
+
autoTrack?: boolean;
|
|
116
|
+
respectDoNotTrack?: boolean;
|
|
117
|
+
excludeSearch?: boolean;
|
|
118
|
+
excludeHash?: boolean;
|
|
119
|
+
allowedEvents?: string[];
|
|
120
|
+
}
|
|
121
|
+
interface AnalyticsRuntime {
|
|
122
|
+
enabled: boolean;
|
|
123
|
+
ready: boolean;
|
|
124
|
+
track: (eventName: string, data?: AnalyticsEventData) => boolean;
|
|
125
|
+
trackPageView: (pathname?: string) => boolean;
|
|
126
|
+
}
|
|
127
|
+
declare function isLocalAnalyticsHostname(hostname: string): boolean;
|
|
128
|
+
declare function sanitizeAnalyticsPath(pathname: string, customNormalizer?: (pathname: string) => string | null): string | null;
|
|
129
|
+
declare function sanitizeAnalyticsEventData(data: AnalyticsEventData | undefined): AnalyticsEventData | undefined;
|
|
130
|
+
declare function isAllowedAnalyticsEvent(eventName: string, allowedEvents: string[] | undefined): boolean;
|
|
131
|
+
declare function fetchAnalyticsPublicConfig(input: {
|
|
132
|
+
apiUrl: string;
|
|
133
|
+
orgId: string;
|
|
134
|
+
siteKey: string;
|
|
135
|
+
stage: string;
|
|
136
|
+
hostname: string;
|
|
137
|
+
signal?: AbortSignal;
|
|
138
|
+
}): Promise<AnalyticsPublicConfig>;
|
|
139
|
+
|
|
96
140
|
/**
|
|
97
141
|
* AxCloud SDK Types
|
|
98
142
|
*
|
|
99
143
|
* Note: In the future, these types should be auto-generated from the OpenAPI spec.
|
|
100
144
|
* For now, they are manually defined based on the AxCloud API.
|
|
101
145
|
*/
|
|
146
|
+
|
|
102
147
|
type AxCloudModule = 'content' | 'members' | 'sections' | 'training' | 'ai' | 'documents' | 'voting';
|
|
103
148
|
type SystemRole = 'super_admin' | 'org_admin' | 'section_admin' | 'member' | 'viewer';
|
|
104
149
|
type UserRole = SystemRole | 'superadmin' | 'admin' | 'editor';
|
|
@@ -292,11 +337,15 @@ interface AxCloudConfig {
|
|
|
292
337
|
stage: string;
|
|
293
338
|
/** API key for public content endpoints (optional - required for public API access) */
|
|
294
339
|
apiKey?: string;
|
|
340
|
+
/** Optional privacy-safe web analytics collection. */
|
|
341
|
+
analytics?: AxCloudAnalyticsOptions;
|
|
295
342
|
auth0: {
|
|
296
343
|
domain: string;
|
|
297
344
|
clientId: string;
|
|
298
345
|
redirectUri: string;
|
|
299
346
|
audience?: string;
|
|
347
|
+
/** Auth0 Organization ID. Use this for invite-only member sites. */
|
|
348
|
+
organization?: string;
|
|
300
349
|
/** Database connection name for password operations. Defaults to 'Username-Password-Authentication' */
|
|
301
350
|
connection?: string;
|
|
302
351
|
};
|
|
@@ -924,11 +973,15 @@ interface AxCloudProviderProps {
|
|
|
924
973
|
stage?: string;
|
|
925
974
|
/** API key for public content endpoints */
|
|
926
975
|
apiKey?: string;
|
|
976
|
+
/** Optional privacy-safe analytics collection through AxCloud. */
|
|
977
|
+
analytics?: AxCloudAnalyticsOptions;
|
|
927
978
|
auth0: {
|
|
928
979
|
domain: string;
|
|
929
980
|
clientId: string;
|
|
930
981
|
redirectUri: string;
|
|
931
982
|
audience?: string;
|
|
983
|
+
/** Auth0 Organization ID. Use this for invite-only member sites. */
|
|
984
|
+
organization?: string;
|
|
932
985
|
/** Database connection name for password operations. Defaults to 'Username-Password-Authentication' */
|
|
933
986
|
connection?: string;
|
|
934
987
|
};
|
|
@@ -950,14 +1003,15 @@ interface AxCloudProviderProps {
|
|
|
950
1003
|
* auth0={{
|
|
951
1004
|
* domain: "auth.axcloud.app",
|
|
952
1005
|
* clientId: "xxx",
|
|
953
|
-
* redirectUri: window.location.origin
|
|
1006
|
+
* redirectUri: window.location.origin,
|
|
1007
|
+
* organization: "org_abc123" // Optional Auth0 Organization ID for invite-only member sites
|
|
954
1008
|
* }}
|
|
955
1009
|
* >
|
|
956
1010
|
* <App />
|
|
957
1011
|
* </AxCloudProvider>
|
|
958
1012
|
* ```
|
|
959
1013
|
*/
|
|
960
|
-
declare function AxCloudProvider({ children, orgId, apiUrl, stage, apiKey, auth0, queryClient, timeout, }: AxCloudProviderProps): react_jsx_runtime.JSX.Element;
|
|
1014
|
+
declare function AxCloudProvider({ children, orgId, apiUrl, stage, apiKey, analytics, auth0, queryClient, timeout, }: AxCloudProviderProps): react_jsx_runtime.JSX.Element;
|
|
961
1015
|
|
|
962
1016
|
interface AxCloudContextValue {
|
|
963
1017
|
config: AxCloudConfig;
|
|
@@ -967,20 +1021,35 @@ interface AxCloudContextValue {
|
|
|
967
1021
|
stage: string;
|
|
968
1022
|
/** Whether using public API mode (API key, no auth) */
|
|
969
1023
|
isPublicMode: boolean;
|
|
1024
|
+
analytics: AnalyticsRuntime;
|
|
970
1025
|
}
|
|
971
1026
|
declare function useAxCloudContext(): AxCloudContextValue;
|
|
972
1027
|
|
|
1028
|
+
type AnalyticsRuntimeConfig = Pick<AxCloudConfig, 'analytics' | 'apiUrl' | 'orgId' | 'stage'>;
|
|
1029
|
+
declare function useAnalyticsRuntime(config: AnalyticsRuntimeConfig): AnalyticsRuntime;
|
|
1030
|
+
declare function useAnalytics(): AnalyticsRuntime;
|
|
1031
|
+
|
|
973
1032
|
interface AuthUser {
|
|
974
1033
|
id: string;
|
|
975
1034
|
email: string;
|
|
976
1035
|
name: string;
|
|
977
1036
|
avatar?: string;
|
|
1037
|
+
/** Auth0's authoritative email verification claim. */
|
|
1038
|
+
emailVerified?: boolean;
|
|
1039
|
+
}
|
|
1040
|
+
interface EmailVerificationResult {
|
|
1041
|
+
success: boolean;
|
|
1042
|
+
status: 'sent' | 'already_verified' | 'rate_limited' | 'failed';
|
|
1043
|
+
message: string;
|
|
1044
|
+
retryAfterSeconds?: number;
|
|
978
1045
|
}
|
|
979
1046
|
interface UseAuthReturn {
|
|
980
1047
|
isAuthenticated: boolean;
|
|
981
1048
|
isLoading: boolean;
|
|
982
1049
|
error: Error | undefined;
|
|
983
1050
|
user: AuthUser | null;
|
|
1051
|
+
/** True only when Auth0 explicitly reports email_verified=false. */
|
|
1052
|
+
needsEmailVerification: boolean;
|
|
984
1053
|
login: (options?: {
|
|
985
1054
|
returnTo?: string;
|
|
986
1055
|
}) => Promise<void>;
|
|
@@ -989,6 +1058,12 @@ interface UseAuthReturn {
|
|
|
989
1058
|
}) => Promise<void>;
|
|
990
1059
|
getAccessToken: () => Promise<string | undefined>;
|
|
991
1060
|
getAuth0Client: () => Auth0ClientState;
|
|
1061
|
+
/** Refresh Auth0 tokens/profile and return the latest email verification state. */
|
|
1062
|
+
refreshUser: () => Promise<boolean>;
|
|
1063
|
+
/** Send a branded verification email that returns to the current product site. */
|
|
1064
|
+
requestEmailVerification: (options?: {
|
|
1065
|
+
returnTo?: string;
|
|
1066
|
+
}) => Promise<EmailVerificationResult>;
|
|
992
1067
|
/** Request a password reset email for the current user or specified email */
|
|
993
1068
|
requestPasswordReset: (email?: string) => Promise<{
|
|
994
1069
|
success: boolean;
|
|
@@ -2083,4 +2158,4 @@ interface LinkedAccountsListProps {
|
|
|
2083
2158
|
*/
|
|
2084
2159
|
declare function LinkedAccountsList({ providers, showConnectButtons, className, onUnlink, onLinkInitiated, renderIdentity, renderAvailableProvider, }: LinkedAccountsListProps): react_jsx_runtime.JSX.Element;
|
|
2085
2160
|
|
|
2086
|
-
export { type AvailableProvider, AxCloudClient, type AxCloudConfig, AxCloudError, type AxCloudErrorCode, type AxCloudModule, AxCloudProvider, type Ballot, type BallotCandidate, type BallotOption, type BallotSeat, type BarnsportActivitiesFilter, type BarnsportActivity, type BarnsportActivityListItem, type BarnsportActivityLocation, type BarnsportActivityResponse, type BarnsportActivitySchedule, type BarnsportInterestSubmissionRequest, type BarnsportInterestSubmissionResponse, type BarnsportListResponse, type BarnsportMunicipality, type BarnsportRegistrationMethod, type BarnsportSitemapResponse, type BarnsportSitemapUrl, type BarnsportSport, type BaseRole, type CastVoteResult, type CodeEligibility, type ContentItem, type ContentQueryOptions, type ContentSlotImage, type ContentSlotMap, type ContentSlotReader, type ContentSlotValue, type CustomRole, type DocumentAudience, type DocumentFolder, type DocumentFolderListResponse, type DocumentItem, type DocumentListResponse, type DocumentQueryOptions, type DocumentSourceProvider, type DocumentStatus, type FormStatsResponse, type FormSubmission, type FormSubmissionRecord, type FormSubmissionResponse, type FormSubmissionsResponse, LinkedAccountsList, type LinkedAccountsListProps, type LinkedIdentity, LoginButton, LogoutButton, type MediaItem, type MediaListResponse, type Membership, ModuleGate, type NewsItem, type Organization, type OrganizationBranding, type OrganizationSettings, type Page, type PageContentState, type PaginatedResponse, ProtectedRoute, type Section, type SectionPermissions, type SignedDocumentUrl, type SignedMediaUrl, type SystemRole, type UseLinkedAccountsReturn, type User, type UserRole, type VoteReceipt, castVote, castVoteWithCode, checkEligibility, checkVotingCode, createClient, createContentSlotReader, createFormHelper, getBallot, getClient, getContentSlotMap, getVotingReceipt, isAxCloudError, submitForm, useAuth, useAvatar, useAxCloudContext, useBarnsportActivities, useBarnsportActivity, useBarnsportMunicipalities, useBarnsportSitemap, useBarnsportSport, useBarnsportSports, useBranding, useCodeBallot, useContent, useContentItem, useDocumentDownload, useDocuments, useFormStats, useForms, useLinkedAccounts, useLogo, useMedia, useMediaList, useMemberDocumentDownload, useMemberDocumentFolders, useMemberDocuments, useModuleAccess, useMySection, useNews, useOrg, usePageContent, useSections, useSubmitBarnsportInterest, useUpdateFormSubmission, useUser, userHasAllPermissions, userHasAnyPermission, userHasPermission };
|
|
2161
|
+
export { type AnalyticsEventData, type AnalyticsEventValue, type AnalyticsPublicConfig, type AnalyticsRuntime, type AnalyticsRuntimeConfig, type Auth0ClientState, type AuthUser, type AvailableProvider, type AxCloudAnalyticsOptions, AxCloudClient, type AxCloudConfig, AxCloudError, type AxCloudErrorCode, type AxCloudModule, AxCloudProvider, type Ballot, type BallotCandidate, type BallotOption, type BallotSeat, type BarnsportActivitiesFilter, type BarnsportActivity, type BarnsportActivityListItem, type BarnsportActivityLocation, type BarnsportActivityResponse, type BarnsportActivitySchedule, type BarnsportInterestSubmissionRequest, type BarnsportInterestSubmissionResponse, type BarnsportListResponse, type BarnsportMunicipality, type BarnsportRegistrationMethod, type BarnsportSitemapResponse, type BarnsportSitemapUrl, type BarnsportSport, type BaseRole, type CastVoteResult, type CodeEligibility, type ContentItem, type ContentQueryOptions, type ContentSlotImage, type ContentSlotMap, type ContentSlotReader, type ContentSlotValue, type CustomRole, type DocumentAudience, type DocumentFolder, type DocumentFolderListResponse, type DocumentItem, type DocumentListResponse, type DocumentQueryOptions, type DocumentSourceProvider, type DocumentStatus, type EmailVerificationResult, type FormStatsResponse, type FormSubmission, type FormSubmissionRecord, type FormSubmissionResponse, type FormSubmissionsResponse, LinkedAccountsList, type LinkedAccountsListProps, type LinkedIdentity, LoginButton, LogoutButton, type MediaItem, type MediaListResponse, type Membership, ModuleGate, type NewsItem, type Organization, type OrganizationBranding, type OrganizationSettings, type Page, type PageContentState, type PaginatedResponse, ProtectedRoute, type Section, type SectionPermissions, type SignedDocumentUrl, type SignedMediaUrl, type SystemRole, type UseAuthReturn, type UseLinkedAccountsReturn, type User, type UserRole, type VoteReceipt, castVote, castVoteWithCode, checkEligibility, checkVotingCode, createClient, createContentSlotReader, createFormHelper, fetchAnalyticsPublicConfig, getBallot, getClient, getContentSlotMap, getVotingReceipt, isAllowedAnalyticsEvent, isAxCloudError, isLocalAnalyticsHostname, sanitizeAnalyticsEventData, sanitizeAnalyticsPath, submitForm, useAnalytics, useAnalyticsRuntime, useAuth, useAvatar, useAxCloudContext, useBarnsportActivities, useBarnsportActivity, useBarnsportMunicipalities, useBarnsportSitemap, useBarnsportSport, useBarnsportSports, useBranding, useCodeBallot, useContent, useContentItem, useDocumentDownload, useDocuments, useFormStats, useForms, useLinkedAccounts, useLogo, useMedia, useMediaList, useMemberDocumentDownload, useMemberDocumentFolders, useMemberDocuments, useModuleAccess, useMySection, useNews, useOrg, usePageContent, useSections, useSubmitBarnsportInterest, useUpdateFormSubmission, useUser, userHasAllPermissions, userHasAnyPermission, userHasPermission };
|
package/dist/index.d.ts
CHANGED
|
@@ -93,12 +93,57 @@ declare class AxCloudError extends Error {
|
|
|
93
93
|
}
|
|
94
94
|
declare function isAxCloudError(error: unknown): error is AxCloudError;
|
|
95
95
|
|
|
96
|
+
type AnalyticsEventValue = string | number | boolean;
|
|
97
|
+
type AnalyticsEventData = Record<string, AnalyticsEventValue>;
|
|
98
|
+
interface AxCloudAnalyticsOptions {
|
|
99
|
+
/** Site key configured in AxCloud, for example "public-web". */
|
|
100
|
+
siteKey: string;
|
|
101
|
+
/** Analytics is opt-in and disabled unless this is true. */
|
|
102
|
+
enabled?: boolean;
|
|
103
|
+
/** Allow local collection for explicit development tests. */
|
|
104
|
+
trackLocalhost?: boolean;
|
|
105
|
+
/** Override path normalization. Return null to skip a pageview. */
|
|
106
|
+
normalizePath?: (pathname: string) => string | null;
|
|
107
|
+
}
|
|
108
|
+
interface AnalyticsPublicConfig {
|
|
109
|
+
enabled: boolean;
|
|
110
|
+
provider?: 'umami';
|
|
111
|
+
websiteId?: string;
|
|
112
|
+
scriptUrl?: string;
|
|
113
|
+
hostUrl?: string;
|
|
114
|
+
domains?: string[];
|
|
115
|
+
autoTrack?: boolean;
|
|
116
|
+
respectDoNotTrack?: boolean;
|
|
117
|
+
excludeSearch?: boolean;
|
|
118
|
+
excludeHash?: boolean;
|
|
119
|
+
allowedEvents?: string[];
|
|
120
|
+
}
|
|
121
|
+
interface AnalyticsRuntime {
|
|
122
|
+
enabled: boolean;
|
|
123
|
+
ready: boolean;
|
|
124
|
+
track: (eventName: string, data?: AnalyticsEventData) => boolean;
|
|
125
|
+
trackPageView: (pathname?: string) => boolean;
|
|
126
|
+
}
|
|
127
|
+
declare function isLocalAnalyticsHostname(hostname: string): boolean;
|
|
128
|
+
declare function sanitizeAnalyticsPath(pathname: string, customNormalizer?: (pathname: string) => string | null): string | null;
|
|
129
|
+
declare function sanitizeAnalyticsEventData(data: AnalyticsEventData | undefined): AnalyticsEventData | undefined;
|
|
130
|
+
declare function isAllowedAnalyticsEvent(eventName: string, allowedEvents: string[] | undefined): boolean;
|
|
131
|
+
declare function fetchAnalyticsPublicConfig(input: {
|
|
132
|
+
apiUrl: string;
|
|
133
|
+
orgId: string;
|
|
134
|
+
siteKey: string;
|
|
135
|
+
stage: string;
|
|
136
|
+
hostname: string;
|
|
137
|
+
signal?: AbortSignal;
|
|
138
|
+
}): Promise<AnalyticsPublicConfig>;
|
|
139
|
+
|
|
96
140
|
/**
|
|
97
141
|
* AxCloud SDK Types
|
|
98
142
|
*
|
|
99
143
|
* Note: In the future, these types should be auto-generated from the OpenAPI spec.
|
|
100
144
|
* For now, they are manually defined based on the AxCloud API.
|
|
101
145
|
*/
|
|
146
|
+
|
|
102
147
|
type AxCloudModule = 'content' | 'members' | 'sections' | 'training' | 'ai' | 'documents' | 'voting';
|
|
103
148
|
type SystemRole = 'super_admin' | 'org_admin' | 'section_admin' | 'member' | 'viewer';
|
|
104
149
|
type UserRole = SystemRole | 'superadmin' | 'admin' | 'editor';
|
|
@@ -292,11 +337,15 @@ interface AxCloudConfig {
|
|
|
292
337
|
stage: string;
|
|
293
338
|
/** API key for public content endpoints (optional - required for public API access) */
|
|
294
339
|
apiKey?: string;
|
|
340
|
+
/** Optional privacy-safe web analytics collection. */
|
|
341
|
+
analytics?: AxCloudAnalyticsOptions;
|
|
295
342
|
auth0: {
|
|
296
343
|
domain: string;
|
|
297
344
|
clientId: string;
|
|
298
345
|
redirectUri: string;
|
|
299
346
|
audience?: string;
|
|
347
|
+
/** Auth0 Organization ID. Use this for invite-only member sites. */
|
|
348
|
+
organization?: string;
|
|
300
349
|
/** Database connection name for password operations. Defaults to 'Username-Password-Authentication' */
|
|
301
350
|
connection?: string;
|
|
302
351
|
};
|
|
@@ -924,11 +973,15 @@ interface AxCloudProviderProps {
|
|
|
924
973
|
stage?: string;
|
|
925
974
|
/** API key for public content endpoints */
|
|
926
975
|
apiKey?: string;
|
|
976
|
+
/** Optional privacy-safe analytics collection through AxCloud. */
|
|
977
|
+
analytics?: AxCloudAnalyticsOptions;
|
|
927
978
|
auth0: {
|
|
928
979
|
domain: string;
|
|
929
980
|
clientId: string;
|
|
930
981
|
redirectUri: string;
|
|
931
982
|
audience?: string;
|
|
983
|
+
/** Auth0 Organization ID. Use this for invite-only member sites. */
|
|
984
|
+
organization?: string;
|
|
932
985
|
/** Database connection name for password operations. Defaults to 'Username-Password-Authentication' */
|
|
933
986
|
connection?: string;
|
|
934
987
|
};
|
|
@@ -950,14 +1003,15 @@ interface AxCloudProviderProps {
|
|
|
950
1003
|
* auth0={{
|
|
951
1004
|
* domain: "auth.axcloud.app",
|
|
952
1005
|
* clientId: "xxx",
|
|
953
|
-
* redirectUri: window.location.origin
|
|
1006
|
+
* redirectUri: window.location.origin,
|
|
1007
|
+
* organization: "org_abc123" // Optional Auth0 Organization ID for invite-only member sites
|
|
954
1008
|
* }}
|
|
955
1009
|
* >
|
|
956
1010
|
* <App />
|
|
957
1011
|
* </AxCloudProvider>
|
|
958
1012
|
* ```
|
|
959
1013
|
*/
|
|
960
|
-
declare function AxCloudProvider({ children, orgId, apiUrl, stage, apiKey, auth0, queryClient, timeout, }: AxCloudProviderProps): react_jsx_runtime.JSX.Element;
|
|
1014
|
+
declare function AxCloudProvider({ children, orgId, apiUrl, stage, apiKey, analytics, auth0, queryClient, timeout, }: AxCloudProviderProps): react_jsx_runtime.JSX.Element;
|
|
961
1015
|
|
|
962
1016
|
interface AxCloudContextValue {
|
|
963
1017
|
config: AxCloudConfig;
|
|
@@ -967,20 +1021,35 @@ interface AxCloudContextValue {
|
|
|
967
1021
|
stage: string;
|
|
968
1022
|
/** Whether using public API mode (API key, no auth) */
|
|
969
1023
|
isPublicMode: boolean;
|
|
1024
|
+
analytics: AnalyticsRuntime;
|
|
970
1025
|
}
|
|
971
1026
|
declare function useAxCloudContext(): AxCloudContextValue;
|
|
972
1027
|
|
|
1028
|
+
type AnalyticsRuntimeConfig = Pick<AxCloudConfig, 'analytics' | 'apiUrl' | 'orgId' | 'stage'>;
|
|
1029
|
+
declare function useAnalyticsRuntime(config: AnalyticsRuntimeConfig): AnalyticsRuntime;
|
|
1030
|
+
declare function useAnalytics(): AnalyticsRuntime;
|
|
1031
|
+
|
|
973
1032
|
interface AuthUser {
|
|
974
1033
|
id: string;
|
|
975
1034
|
email: string;
|
|
976
1035
|
name: string;
|
|
977
1036
|
avatar?: string;
|
|
1037
|
+
/** Auth0's authoritative email verification claim. */
|
|
1038
|
+
emailVerified?: boolean;
|
|
1039
|
+
}
|
|
1040
|
+
interface EmailVerificationResult {
|
|
1041
|
+
success: boolean;
|
|
1042
|
+
status: 'sent' | 'already_verified' | 'rate_limited' | 'failed';
|
|
1043
|
+
message: string;
|
|
1044
|
+
retryAfterSeconds?: number;
|
|
978
1045
|
}
|
|
979
1046
|
interface UseAuthReturn {
|
|
980
1047
|
isAuthenticated: boolean;
|
|
981
1048
|
isLoading: boolean;
|
|
982
1049
|
error: Error | undefined;
|
|
983
1050
|
user: AuthUser | null;
|
|
1051
|
+
/** True only when Auth0 explicitly reports email_verified=false. */
|
|
1052
|
+
needsEmailVerification: boolean;
|
|
984
1053
|
login: (options?: {
|
|
985
1054
|
returnTo?: string;
|
|
986
1055
|
}) => Promise<void>;
|
|
@@ -989,6 +1058,12 @@ interface UseAuthReturn {
|
|
|
989
1058
|
}) => Promise<void>;
|
|
990
1059
|
getAccessToken: () => Promise<string | undefined>;
|
|
991
1060
|
getAuth0Client: () => Auth0ClientState;
|
|
1061
|
+
/** Refresh Auth0 tokens/profile and return the latest email verification state. */
|
|
1062
|
+
refreshUser: () => Promise<boolean>;
|
|
1063
|
+
/** Send a branded verification email that returns to the current product site. */
|
|
1064
|
+
requestEmailVerification: (options?: {
|
|
1065
|
+
returnTo?: string;
|
|
1066
|
+
}) => Promise<EmailVerificationResult>;
|
|
992
1067
|
/** Request a password reset email for the current user or specified email */
|
|
993
1068
|
requestPasswordReset: (email?: string) => Promise<{
|
|
994
1069
|
success: boolean;
|
|
@@ -2083,4 +2158,4 @@ interface LinkedAccountsListProps {
|
|
|
2083
2158
|
*/
|
|
2084
2159
|
declare function LinkedAccountsList({ providers, showConnectButtons, className, onUnlink, onLinkInitiated, renderIdentity, renderAvailableProvider, }: LinkedAccountsListProps): react_jsx_runtime.JSX.Element;
|
|
2085
2160
|
|
|
2086
|
-
export { type AvailableProvider, AxCloudClient, type AxCloudConfig, AxCloudError, type AxCloudErrorCode, type AxCloudModule, AxCloudProvider, type Ballot, type BallotCandidate, type BallotOption, type BallotSeat, type BarnsportActivitiesFilter, type BarnsportActivity, type BarnsportActivityListItem, type BarnsportActivityLocation, type BarnsportActivityResponse, type BarnsportActivitySchedule, type BarnsportInterestSubmissionRequest, type BarnsportInterestSubmissionResponse, type BarnsportListResponse, type BarnsportMunicipality, type BarnsportRegistrationMethod, type BarnsportSitemapResponse, type BarnsportSitemapUrl, type BarnsportSport, type BaseRole, type CastVoteResult, type CodeEligibility, type ContentItem, type ContentQueryOptions, type ContentSlotImage, type ContentSlotMap, type ContentSlotReader, type ContentSlotValue, type CustomRole, type DocumentAudience, type DocumentFolder, type DocumentFolderListResponse, type DocumentItem, type DocumentListResponse, type DocumentQueryOptions, type DocumentSourceProvider, type DocumentStatus, type FormStatsResponse, type FormSubmission, type FormSubmissionRecord, type FormSubmissionResponse, type FormSubmissionsResponse, LinkedAccountsList, type LinkedAccountsListProps, type LinkedIdentity, LoginButton, LogoutButton, type MediaItem, type MediaListResponse, type Membership, ModuleGate, type NewsItem, type Organization, type OrganizationBranding, type OrganizationSettings, type Page, type PageContentState, type PaginatedResponse, ProtectedRoute, type Section, type SectionPermissions, type SignedDocumentUrl, type SignedMediaUrl, type SystemRole, type UseLinkedAccountsReturn, type User, type UserRole, type VoteReceipt, castVote, castVoteWithCode, checkEligibility, checkVotingCode, createClient, createContentSlotReader, createFormHelper, getBallot, getClient, getContentSlotMap, getVotingReceipt, isAxCloudError, submitForm, useAuth, useAvatar, useAxCloudContext, useBarnsportActivities, useBarnsportActivity, useBarnsportMunicipalities, useBarnsportSitemap, useBarnsportSport, useBarnsportSports, useBranding, useCodeBallot, useContent, useContentItem, useDocumentDownload, useDocuments, useFormStats, useForms, useLinkedAccounts, useLogo, useMedia, useMediaList, useMemberDocumentDownload, useMemberDocumentFolders, useMemberDocuments, useModuleAccess, useMySection, useNews, useOrg, usePageContent, useSections, useSubmitBarnsportInterest, useUpdateFormSubmission, useUser, userHasAllPermissions, userHasAnyPermission, userHasPermission };
|
|
2161
|
+
export { type AnalyticsEventData, type AnalyticsEventValue, type AnalyticsPublicConfig, type AnalyticsRuntime, type AnalyticsRuntimeConfig, type Auth0ClientState, type AuthUser, type AvailableProvider, type AxCloudAnalyticsOptions, AxCloudClient, type AxCloudConfig, AxCloudError, type AxCloudErrorCode, type AxCloudModule, AxCloudProvider, type Ballot, type BallotCandidate, type BallotOption, type BallotSeat, type BarnsportActivitiesFilter, type BarnsportActivity, type BarnsportActivityListItem, type BarnsportActivityLocation, type BarnsportActivityResponse, type BarnsportActivitySchedule, type BarnsportInterestSubmissionRequest, type BarnsportInterestSubmissionResponse, type BarnsportListResponse, type BarnsportMunicipality, type BarnsportRegistrationMethod, type BarnsportSitemapResponse, type BarnsportSitemapUrl, type BarnsportSport, type BaseRole, type CastVoteResult, type CodeEligibility, type ContentItem, type ContentQueryOptions, type ContentSlotImage, type ContentSlotMap, type ContentSlotReader, type ContentSlotValue, type CustomRole, type DocumentAudience, type DocumentFolder, type DocumentFolderListResponse, type DocumentItem, type DocumentListResponse, type DocumentQueryOptions, type DocumentSourceProvider, type DocumentStatus, type EmailVerificationResult, type FormStatsResponse, type FormSubmission, type FormSubmissionRecord, type FormSubmissionResponse, type FormSubmissionsResponse, LinkedAccountsList, type LinkedAccountsListProps, type LinkedIdentity, LoginButton, LogoutButton, type MediaItem, type MediaListResponse, type Membership, ModuleGate, type NewsItem, type Organization, type OrganizationBranding, type OrganizationSettings, type Page, type PageContentState, type PaginatedResponse, ProtectedRoute, type Section, type SectionPermissions, type SignedDocumentUrl, type SignedMediaUrl, type SystemRole, type UseAuthReturn, type UseLinkedAccountsReturn, type User, type UserRole, type VoteReceipt, castVote, castVoteWithCode, checkEligibility, checkVotingCode, createClient, createContentSlotReader, createFormHelper, fetchAnalyticsPublicConfig, getBallot, getClient, getContentSlotMap, getVotingReceipt, isAllowedAnalyticsEvent, isAxCloudError, isLocalAnalyticsHostname, sanitizeAnalyticsEventData, sanitizeAnalyticsPath, submitForm, useAnalytics, useAnalyticsRuntime, useAuth, useAvatar, useAxCloudContext, useBarnsportActivities, useBarnsportActivity, useBarnsportMunicipalities, useBarnsportSitemap, useBarnsportSport, useBarnsportSports, useBranding, useCodeBallot, useContent, useContentItem, useDocumentDownload, useDocuments, useFormStats, useForms, useLinkedAccounts, useLogo, useMedia, useMediaList, useMemberDocumentDownload, useMemberDocumentFolders, useMemberDocuments, useModuleAccess, useMySection, useNews, useOrg, usePageContent, useSections, useSubmitBarnsportInterest, useUpdateFormSubmission, useUser, userHasAllPermissions, userHasAnyPermission, userHasPermission };
|