@axcode/axcloud-sdk 0.1.6 → 0.1.7-dev.332678a

package/dist/index.d.ts

@@ -297,6 +297,8 @@ interface AxCloudConfig {
         clientId: string;
         redirectUri: string;
         audience?: string;
+        /** Auth0 Organization ID. Use this for invite-only member sites. */
+        organization?: string;
         /** Database connection name for password operations. Defaults to 'Username-Password-Authentication' */
         connection?: string;
     };
@@ -366,6 +368,247 @@ interface MediaListResponse {
     bucket: string;
     prefix: string;
 }
+type DocumentStatus = 'draft' | 'published' | 'archived';
+type DocumentAudience = 'public' | 'members' | 'section' | 'internal';
+type DocumentSourceProvider = 'upload' | 'sharepoint';
+/**
+ * Public document metadata exposed through the AxCloud SDK.
+ */
+interface DocumentItem {
+    document_id: string;
+    org_id: string;
+    title: string;
+    description?: string;
+    filename: string;
+    mime_type: string;
+    size: number;
+    status: DocumentStatus;
+    audience: DocumentAudience;
+    tags: string[];
+    source_provider: DocumentSourceProvider;
+    created_at: string;
+    updated_at: string;
+    published_at?: string;
+    /** Section IDs this document is scoped to (member endpoint only). */
+    section_ids?: string[];
+    /** Display name of the member who uploaded the document (member endpoint only). */
+    uploaded_by_name?: string;
+    /** Folder IDs this document belongs to (member endpoint only). */
+    folder_ids?: string[];
+}
+interface DocumentListResponse {
+    items: DocumentItem[];
+    count: number;
+}
+/**
+ * A document folder the current member is allowed to see.
+ *
+ * Members receive folders for their own sections plus org-level folders
+ * (`section_id === null`). Returned by the member document-folders endpoint.
+ */
+interface DocumentFolder {
+    id: string;
+    /** Section this folder belongs to, or `null` for org-level folders. */
+    section_id: string | null;
+    /** Parent folder for nesting, or `null` for a top-level folder. */
+    parent_folder_id: string | null;
+    name: string;
+    sort_order: number;
+}
+interface DocumentFolderListResponse {
+    folders: DocumentFolder[];
+}
+interface SignedDocumentUrl {
+    documentId: string;
+    url: string;
+    expiresIn: number;
+    filename: string;
+    mimeType: string;
+}
+interface DocumentQueryOptions {
+    search?: string;
+    tags?: string[];
+    limit?: number;
+    /** Restrict results to documents belonging to this folder (member endpoint only). */
+    folderId?: string;
+}
+
+interface BarnsportMunicipality {
+    id: string;
+    slug: string;
+    name: string;
+    county?: string;
+    geo?: {
+        lat: number;
+        lng: number;
+        bounds?: [number, number, number, number];
+    };
+}
+interface BarnsportSportArticle {
+    short_description?: string;
+    what_is_it?: string;
+    why_fun?: string;
+    good_to_know?: {
+        age?: string;
+        equipment?: string;
+        cost?: string;
+    };
+    fun_facts?: string[];
+}
+interface BarnsportSport {
+    id: string;
+    slug: string;
+    name: string;
+    icon?: string;
+    color?: string;
+    category?: string;
+    is_featured?: boolean;
+    hero_image_url?: string;
+    short_description?: string;
+    /** Present on the single-sport endpoint (GET /public/{orgId}/sports/{slug}). */
+    article?: BarnsportSportArticle;
+}
+interface BarnsportActivitySchedule {
+    weekday?: number;
+    starts_at?: string;
+    ends_at?: string;
+    label?: string;
+    season?: string;
+}
+interface BarnsportActivityLocation {
+    name?: string;
+    address?: string;
+    lat?: number;
+    lng?: number;
+}
+interface BarnsportRegistrationMethod {
+    type: 'url' | 'email' | 'phone' | 'form' | 'external';
+    label?: string;
+    value: string;
+    instructions?: string;
+    preferred?: boolean;
+}
+interface BarnsportActivityListItem {
+    id: string;
+    slug: string;
+    title: string;
+    summary?: string;
+    sport: {
+        id: string;
+        slug: string;
+        name?: string;
+        icon?: string;
+    };
+    municipality: {
+        id: string;
+        slug: string;
+        name?: string;
+    };
+    club: {
+        id: string;
+        slug: string;
+        name?: string;
+    };
+    birthYears?: number[];
+    minBirthYear?: number;
+    maxBirthYear?: number;
+    ageLabel?: string;
+    schedule: BarnsportActivitySchedule[];
+    location?: BarnsportActivityLocation;
+    registrationSummary?: string;
+    updatedAt: string;
+}
+interface BarnsportActivity {
+    activity_id: string;
+    org_id: string;
+    slug: string;
+    title: string;
+    summary?: string;
+    description?: string;
+    sport_id: string;
+    sport_slug: string;
+    sport_name?: string;
+    sport_icon?: string;
+    municipality_id: string;
+    municipality_slug: string;
+    municipality_name?: string;
+    club_id: string;
+    club_slug: string;
+    club_name?: string;
+    club_website_url?: string;
+    birth_years?: number[];
+    min_birth_year?: number;
+    max_birth_year?: number;
+    age_label?: string;
+    schedule: BarnsportActivitySchedule[];
+    location?: BarnsportActivityLocation;
+    registration: {
+        methods: BarnsportRegistrationMethod[];
+        deadline?: string;
+        price_label?: string;
+    };
+    seo?: {
+        title?: string;
+        description?: string;
+        image_media_id?: string;
+    };
+    published_at?: string;
+    updated_at: string;
+}
+interface BarnsportActivitiesFilter {
+    municipality?: string;
+    sport?: string;
+    birthYear?: number;
+    q?: string;
+    search?: string;
+    sort?: 'updated' | 'name' | 'relevance';
+    cursor?: string;
+    limit?: number;
+}
+interface BarnsportListResponse<T> {
+    items: T[];
+    count: number;
+    nextCursor?: string | null;
+}
+interface BarnsportActivityResponse {
+    activity: BarnsportActivity;
+}
+interface BarnsportSitemapUrl {
+    loc: string;
+    lastmod?: string;
+    changefreq?: string;
+    priority?: number;
+}
+interface BarnsportSitemapResponse {
+    baseUrl: string;
+    updatedAt: string;
+    urls: BarnsportSitemapUrl[];
+}
+interface BarnsportInterestSubmissionRequest {
+    activitySlug: string;
+    guardianName: string;
+    guardianEmail: string;
+    guardianPhone?: string;
+    childName?: string;
+    childBirthYear?: number;
+    message?: string;
+    consent: {
+        contact: boolean;
+        privacyVersion: string;
+    };
+    honeypot?: string;
+    source?: {
+        site?: string;
+        pageUrl?: string;
+        utm?: Record<string, string>;
+    };
+}
+interface BarnsportInterestSubmissionResponse {
+    success: boolean;
+    submissionId?: string;
+    duplicate?: boolean;
+    message: string;
+}
 
 type ContentSlotValue = string | number | boolean | null | undefined | string[] | Record<string, unknown> | unknown[];
 type ContentSlotMap = Record<string, ContentSlotValue>;
@@ -553,6 +796,128 @@ declare function createFormHelper(config: {
     submit: (formType: "waitlist" | "contact" | "membership", email: string, data?: Record<string, unknown>) => Promise<FormSubmissionResponse>;
 };
 
+/**
+ * AxCloud Voting Module
+ *
+ * Functions for embedding voting/elections on a customer site (e.g. spf.se).
+ *
+ * Two channels:
+ *  - PUBLIC (code): no login — the personal one-time code is the credential.
+ *    Use {@link checkVotingCode}, {@link castVoteWithCode}, {@link getVotingReceipt}.
+ *  - AUTHED (Auth0): a logged-in member votes with their access token.
+ *    Use {@link getBallot}, {@link checkEligibility}, {@link castVote}.
+ *
+ * `votingApiUrl` is the Voting API base, e.g. 'https://api.axcloud.app/voting'.
+ */
+interface BallotSeat {
+    seat_id: string;
+    label_sv: string;
+    label_en?: string;
+    term?: string;
+    count: number;
+    order?: number;
+}
+interface BallotCandidate {
+    candidate_id: string;
+    name: string;
+    bio_sv?: string;
+    bio_en?: string;
+    presentation_media_id?: string;
+    photo_media_id?: string;
+}
+interface BallotOption {
+    option_id: string;
+    text: string;
+    description?: string;
+}
+interface Ballot {
+    poll_id: string;
+    poll_type: 'single_choice' | 'multiple_choice' | 'ranking' | 'election';
+    title: string;
+    title_en?: string;
+    description?: string;
+    description_en?: string;
+    seats?: BallotSeat[];
+    max_selections?: number;
+    min_selections?: number;
+    ends_at?: string;
+    options?: BallotOption[];
+    candidates?: BallotCandidate[];
+}
+interface CodeEligibility {
+    eligible: boolean;
+    has_voted: boolean;
+    reason?: string;
+    ballot?: Ballot;
+}
+interface VoteReceipt {
+    has_voted: boolean;
+    voted_at?: string;
+    selected_option_ids?: string[];
+    selection?: string[];
+}
+interface CastVoteResult {
+    success: boolean;
+    voted_at?: string;
+    message?: string;
+}
+/**
+ * Validate a personal code and, if valid, return the ballot to render.
+ */
+declare function checkVotingCode(votingApiUrl: string, params: {
+    orgId: string;
+    pollId: string;
+    code: string;
+}): Promise<CodeEligibility>;
+/**
+ * Cast a vote using a personal code.
+ */
+declare function castVoteWithCode(votingApiUrl: string, params: {
+    orgId: string;
+    pollId: string;
+    code: string;
+    selectedOptions: string[];
+    rankings?: Record<string, number>;
+}): Promise<CastVoteResult>;
+/**
+ * After voting, re-check a code to retrieve the voter's own selection.
+ */
+declare function getVotingReceipt(votingApiUrl: string, params: {
+    orgId: string;
+    pollId: string;
+    code: string;
+}): Promise<VoteReceipt>;
+/**
+ * Load a ballot (poll + candidates) for a logged-in member.
+ */
+declare function getBallot(votingApiUrl: string, params: {
+    orgId: string;
+    pollId: string;
+    accessToken: string;
+}): Promise<Ballot>;
+/**
+ * Check whether the logged-in member is eligible to vote / has already voted.
+ */
+declare function checkEligibility(votingApiUrl: string, params: {
+    orgId: string;
+    pollId: string;
+    accessToken: string;
+}): Promise<{
+    eligible: boolean;
+    has_voted: boolean;
+    reason?: string;
+}>;
+/**
+ * Cast a vote as a logged-in member.
+ */
+declare function castVote(votingApiUrl: string, params: {
+    orgId: string;
+    pollId: string;
+    accessToken: string;
+    selectedOptions: string[];
+    rankings?: Record<string, number>;
+}): Promise<CastVoteResult>;
+
 interface AxCloudProviderProps {
     children: React.ReactNode;
     orgId: string;
@@ -566,6 +931,8 @@ interface AxCloudProviderProps {
         clientId: string;
         redirectUri: string;
         audience?: string;
+        /** Auth0 Organization ID. Use this for invite-only member sites. */
+        organization?: string;
         /** Database connection name for password operations. Defaults to 'Username-Password-Authentication' */
         connection?: string;
     };
@@ -587,7 +954,8 @@ interface AxCloudProviderProps {
  *   auth0={{
  *     domain: "auth.axcloud.app",
  *     clientId: "xxx",
- *     redirectUri: window.location.origin
+ *     redirectUri: window.location.origin,
+ *     organization: "org_abc123" // Optional Auth0 Organization ID for invite-only member sites
  *   }}
  * >
  *   <App />
@@ -612,12 +980,22 @@ interface AuthUser {
     email: string;
     name: string;
     avatar?: string;
+    /** Auth0's authoritative email verification claim. */
+    emailVerified?: boolean;
+}
+interface EmailVerificationResult {
+    success: boolean;
+    status: 'sent' | 'already_verified' | 'rate_limited' | 'failed';
+    message: string;
+    retryAfterSeconds?: number;
 }
 interface UseAuthReturn {
     isAuthenticated: boolean;
     isLoading: boolean;
     error: Error | undefined;
     user: AuthUser | null;
+    /** True only when Auth0 explicitly reports email_verified=false. */
+    needsEmailVerification: boolean;
     login: (options?: {
         returnTo?: string;
     }) => Promise<void>;
@@ -626,6 +1004,12 @@ interface UseAuthReturn {
     }) => Promise<void>;
     getAccessToken: () => Promise<string | undefined>;
     getAuth0Client: () => Auth0ClientState;
+    /** Refresh Auth0 tokens/profile and return the latest email verification state. */
+    refreshUser: () => Promise<boolean>;
+    /** Send a branded verification email that returns to the current product site. */
+    requestEmailVerification: (options?: {
+        returnTo?: string;
+    }) => Promise<EmailVerificationResult>;
     /** Request a password reset email for the current user or specified email */
     requestPasswordReset: (email?: string) => Promise<{
         success: boolean;
@@ -1132,6 +1516,25 @@ declare function useUpdateFormSubmission(): _tanstack_react_query.UseMutationRes
     notes?: string;
 }, unknown>;
 
+type CodeBallotStage = 'enter_code' | 'ballot' | 'submitted' | 'already_voted';
+interface UseCodeBallotOptions {
+    pollId: string;
+    /** Override the Voting API base URL. Defaults to `${config.apiUrl}/voting`. */
+    votingApiUrl?: string;
+}
+declare function useCodeBallot({ pollId, votingApiUrl }: UseCodeBallotOptions): {
+    stage: CodeBallotStage;
+    code: string;
+    ballot: Ballot | null;
+    receipt: VoteReceipt | null;
+    reason: string | undefined;
+    loading: boolean;
+    error: string | null;
+    validateCode: (inputCode: string) => Promise<CodeEligibility | null>;
+    submitVote: (selectedOptions: string[], rankings?: Record<string, number>) => Promise<boolean>;
+    reset: () => void;
+};
+
 /**
  * useLinkedAccounts Hook
  *
@@ -1344,6 +1747,138 @@ declare function useMedia(mediaId: string): {
     refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<SignedMediaUrl, Error>>;
 };
 
+/**
+ * List documents that have been explicitly published for public SDK access.
+ *
+ * Documents with members/internal/section audience stay inside AxCloud.
+ */
+declare function useDocuments(options?: DocumentQueryOptions): {
+    documents: DocumentItem[];
+    items: DocumentItem[];
+    count: number;
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<DocumentListResponse, Error>>;
+};
+/**
+ * Fetch a short-lived signed download URL for a public document.
+ */
+declare function useDocumentDownload(documentId: string | undefined): {
+    url: string | null;
+    documentUrl: string | null;
+    filename: string | null;
+    mimeType: string | null;
+    expiresIn: number | null;
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<SignedDocumentUrl, Error>>;
+};
+/**
+ * List documents the current member is allowed to see.
+ *
+ * Hits the member endpoint (`/documents/members/...`) which is NOT a
+ * `/public/` path, so the core client automatically attaches the member's
+ * `Authorization: Bearer <JWT>` header instead of the public API key.
+ *
+ * Returns public documents plus members/internal documents and section
+ * documents for the member's sections. Items include `section_ids` and
+ * uploader metadata (`uploaded_by_name`, `created_at`).
+ */
+declare function useMemberDocuments(options?: DocumentQueryOptions): {
+    documents: DocumentItem[];
+    items: DocumentItem[];
+    count: number;
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<DocumentListResponse, Error>>;
+};
+/**
+ * List the document folders the current member is allowed to see.
+ *
+ * Hits the member endpoint (`/documents/members/${orgId}/document-folders`),
+ * which is NOT a `/public/` path, so the core client attaches the member's
+ * `Authorization: Bearer <JWT>` header instead of the public API key.
+ *
+ * Returns the member's section folders plus org-level folders
+ * (`section_id === null`). Use the returned folder ids with
+ * `useMemberDocuments({ folderId })` to scope a document list.
+ */
+declare function useMemberDocumentFolders(): {
+    folders: DocumentFolder[];
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<DocumentFolderListResponse, Error>>;
+};
+/**
+ * Fetch a short-lived signed download URL for a member-accessible document.
+ */
+declare function useMemberDocumentDownload(documentId: string | undefined): {
+    url: string | null;
+    documentUrl: string | null;
+    filename: string | null;
+    mimeType: string | null;
+    expiresIn: number | null;
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<SignedDocumentUrl, Error>>;
+};
+
+declare function useBarnsportMunicipalities(): {
+    municipalities: BarnsportMunicipality[];
+    count: number;
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<BarnsportListResponse<BarnsportMunicipality>, Error>>;
+};
+declare function useBarnsportSports(): {
+    sports: BarnsportSport[];
+    count: number;
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<BarnsportListResponse<BarnsportSport>, Error>>;
+};
+declare function useBarnsportSport(slug: string | undefined): {
+    sport: BarnsportSport | null;
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<{
+        sport: BarnsportSport;
+    }, Error>>;
+};
+declare function useBarnsportActivities(filters?: BarnsportActivitiesFilter): {
+    activities: BarnsportActivityListItem[];
+    count: number;
+    nextCursor: string | null;
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<BarnsportListResponse<BarnsportActivityListItem>, Error>>;
+};
+declare function useBarnsportActivity(slug: string | undefined): {
+    activity: BarnsportActivity | null;
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<BarnsportActivityResponse, Error>>;
+};
+declare function useBarnsportSitemap(baseUrl?: string): {
+    sitemap: BarnsportSitemapResponse | null;
+    urls: BarnsportSitemapUrl[];
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<BarnsportSitemapResponse, Error>>;
+};
+declare function useSubmitBarnsportInterest(): _tanstack_react_query.UseMutationResult<BarnsportInterestSubmissionResponse, Error, BarnsportInterestSubmissionRequest, unknown>;
+
 interface LoginButtonProps {
     /**
      * Button text when not authenticated
@@ -1569,4 +2104,4 @@ interface LinkedAccountsListProps {
  */
 declare function LinkedAccountsList({ providers, showConnectButtons, className, onUnlink, onLinkInitiated, renderIdentity, renderAvailableProvider, }: LinkedAccountsListProps): react_jsx_runtime.JSX.Element;
 
-export { type AvailableProvider, AxCloudClient, type AxCloudConfig, AxCloudError, type AxCloudErrorCode, type AxCloudModule, AxCloudProvider, type BaseRole, type ContentItem, type ContentQueryOptions, type ContentSlotImage, type ContentSlotMap, type ContentSlotReader, type ContentSlotValue, type CustomRole, 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 SignedMediaUrl, type SystemRole, type UseLinkedAccountsReturn, type User, type UserRole, createClient, createContentSlotReader, createFormHelper, getClient, getContentSlotMap, isAxCloudError, submitForm, useAuth, useAvatar, useAxCloudContext, useBranding, useContent, useContentItem, useFormStats, useForms, useLinkedAccounts, useLogo, useMedia, useMediaList, useModuleAccess, useMySection, useNews, useOrg, usePageContent, useSections, useUpdateFormSubmission, useUser, userHasAllPermissions, userHasAnyPermission, userHasPermission };
+export { type Auth0ClientState, type AuthUser, 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 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, 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 };