@axcode/axcloud-sdk 0.1.7-dev.bf490b9 → 0.1.7-dev.cc5cc69

package/dist/index.d.ts

@@ -209,6 +209,10 @@ interface User {
     name: string;
     firstName?: string;
     lastName?: string;
+    /** Organization-specific title/position. Managed by organization administrators. */
+    title?: string | null;
+    phone?: string | null;
+    address?: string | null;
     avatar?: string;
     organizationId: string;
     sectionId?: string;
@@ -237,6 +241,8 @@ interface Membership {
     sectionId?: string;
     section?: Section;
     role: UserRole;
+    /** Organization-specific title/position, separate from the access role. */
+    title?: string | null;
     status: 'active' | 'pending' | 'suspended' | 'expired';
     joinedAt: string;
     expiresAt?: string;
@@ -271,7 +277,8 @@ type ContentPublicationState = 'draft' | 'published' | 'archived';
 type ContentAudience = 'public' | 'internal' | 'members' | 'section';
 interface ContentItem {
     id: string;
-    organizationId: string;
+    /** Present when a consumer needs to distinguish organizations outside its configured provider. */
+    organizationId?: string;
     type: string;
     title: string;
     slug: string;
@@ -290,6 +297,7 @@ interface ContentItem {
     };
     status?: ContentPublicationState;
     visibility?: ContentPublicationState;
+    /** @deprecated Delivery access is derived from publication metadata and the verified visitor. */
     audience?: ContentAudience;
     sectionId?: string;
     tags?: string[];
@@ -323,13 +331,19 @@ interface Page extends ContentItem {
     template?: string;
     order?: number;
 }
-interface PaginatedResponse<T> {
+interface ContentListResponse<T> {
     items: T[];
+    count: number;
     total: number;
     page: number;
     pageSize: number;
     hasMore: boolean;
+    nextCursor?: string;
 }
+/** @deprecated Use ContentListResponse. */
+type PaginatedResponse<T> = ContentListResponse<T>;
+type ContentCollectionType = 'news' | 'pages' | 'events';
+type ContentDetailType = 'news' | 'page' | 'event';
 interface AxCloudConfig {
     orgId: string;
     apiUrl: string;
@@ -353,13 +367,17 @@ interface AxCloudConfig {
 interface ContentQueryOptions {
     page?: number;
     pageSize?: number;
+    /** @deprecated Delivery endpoints always return the published snapshot. */
     status?: ContentPublicationState;
+    /** @deprecated Delivery endpoints always return the published snapshot. */
     visibility?: ContentPublicationState;
     audience?: ContentAudience;
+    /** @deprecated Member section access is derived from the verified token. */
     sectionId?: string;
     search?: string;
-    sortBy?: string;
+    sortBy?: 'publishedAt' | 'createdAt' | 'updatedAt' | 'title';
     sortOrder?: 'asc' | 'desc';
+    tags?: string[];
     /** Return the requested translation when content has language variants. */
     lang?: string;
     /** Force public endpoint even when authenticated (for public pages) */
@@ -668,7 +686,10 @@ interface ContentSlotReader {
     fields: ContentSlotMap;
     value<T = ContentSlotValue>(key: string, fallback?: T): ContentSlotValue | T;
     text(key: string, fallback?: string): string;
+    /** @deprecated HTML is untrusted. Prefer text(), or unsafeHtml() with sanitization. */
     html(key: string, fallback?: string): string;
+    /** Returns untrusted CMS HTML. Sanitize it before inserting it into the DOM. */
+    unsafeHtml(key: string, fallback?: string): string;
     list(key: string, fallback?: string[]): string[];
     image(key: string, fallback?: ContentSlotImage): ContentSlotImage | undefined;
 }
@@ -1011,7 +1032,7 @@ interface AxCloudProviderProps {
  * </AxCloudProvider>
  * ```
  */
-declare function AxCloudProvider({ children, orgId, apiUrl, stage, apiKey, analytics, auth0, queryClient, timeout, }: AxCloudProviderProps): react_jsx_runtime.JSX.Element;
+declare function AxCloudProvider({ children, orgId, apiUrl, stage, apiKey, analytics, auth0, queryClient: providedQueryClient, timeout, }: AxCloudProviderProps): react_jsx_runtime.JSX.Element;
 
 interface AxCloudContextValue {
     config: AxCloudConfig;
@@ -1021,6 +1042,14 @@ interface AxCloudContextValue {
     stage: string;
     /** Whether using public API mode (API key, no auth) */
     isPublicMode: boolean;
+    /** Auth0 has completed its initial session check. */
+    isAuthLoading?: boolean;
+    /** Whether the current browser session is authenticated. */
+    isAuthenticated?: boolean;
+    /** Auth0 subject used to isolate member-only query caches. */
+    authSubject?: string;
+    /** Remove identity-bound AxCloud query data before logout or account changes. */
+    clearContentCache?: () => void;
     analytics: AnalyticsRuntime;
 }
 declare function useAxCloudContext(): AxCloudContextValue;
@@ -1114,13 +1143,45 @@ interface Auth0ClientState {
  */
 declare function useAuth(): UseAuthReturn;
 
+interface UserOrganizationSection {
+    id: string;
+    name: string;
+    role: string;
+}
+interface UserOrganizationMembership {
+    role: string;
+    roles: string[];
+    title: string | null;
+    status: string | null;
+    joinedAt: string | null;
+    memberSince: string | null;
+    sectionId: string | null;
+    sectionIds: string[];
+    sections: UserOrganizationSection[];
+}
 interface UserApiResponse extends User {
-    all_org_ids?: string[];
-    organization_memberships?: Record<string, {
-        role: string;
-        sections?: string[];
-    }>;
-    isSuperAdmin?: boolean;
+    allOrgIds: string[];
+    organizationMemberships: Record<string, UserOrganizationMembership>;
+    effectiveOrganizationId: string | null;
+    isSuperAdmin: boolean;
+}
+interface UpdateMyProfileInput {
+    firstName?: string;
+    lastName?: string;
+    phone?: string | null;
+    address?: string | null;
+}
+interface MyProfileResponse {
+    user_id: string;
+    email: string;
+    given_name: string;
+    family_name: string;
+    name: string;
+    phone_number: string | null;
+    phone: string | null;
+    address: string | null;
+    location: string | null;
+    updated_at: string;
 }
 /**
  * useUser - Fetch the current authenticated user from AxCloud
@@ -1156,7 +1217,14 @@ declare function useUser(): {
     error: Error | null;
     refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<UserApiResponse, Error>>;
     hasOrgAccess: boolean;
-    roleInOrg: string | null;
+    roleInOrg: UserRole | null;
+    organizationMembership: UserOrganizationMembership | null;
+    title: string | null;
+    section: UserOrganizationSection;
+    sections: UserOrganizationSection[];
+    sectionIds: string[];
+    joinedAt: string | null;
+    memberSince: string | null;
     isAuthenticated: boolean;
     role: UserRole | null;
     organizationId: string | null;
@@ -1164,6 +1232,11 @@ declare function useUser(): {
     permissions: string[];
     isSuperAdmin: boolean;
 };
+/**
+ * Updates the authenticated user's self-service profile fields.
+ * Organization title, email, roles and membership data are intentionally not writable here.
+ */
+declare function useUpdateMyProfile(): _tanstack_react_query.UseMutationResult<MyProfileResponse, Error, UpdateMyProfileInput, unknown>;
 
 /**
  * Public organization response from /content/public/{orgId}/org
@@ -1248,112 +1321,58 @@ declare function useOrg(): {
 };
 
 /**
- * useNews - Fetch news articles for the organization
- *
- * When authenticated (isPublicMode = false), fetches news visible to members
- * including public, internal, and members-only content.
- *
- * When not authenticated (isPublicMode = true), fetches only public news.
- *
- * @example
- * ```tsx
- * function NewsPage() {
- *   const { data: news, isLoading, isError, error } = useNews()
- *
- *   if (isLoading) return <Spinner />
- *   if (isError) return <Error message={error.message} />
- *
- *   return (
- *     <ul>
- *       {news.map(item => (
- *         <li key={item.id}>{item.title}</li>
- *       ))}
- *     </ul>
- *   )
- * }
- * ```
+ * Fetch published news visible to the current visitor.
  *
- * @example
- * // With pagination
- * ```tsx
- * const { data, hasMore, refetch } = useNews({
- *   pageSize: 10,
- *   status: 'published'
- * })
- * ```
+ * This typed convenience wrapper shares access, cache and pagination behavior
+ * with the generic content hook.
  */
 declare function useNews(options?: ContentQueryOptions): {
     data: NewsItem[];
+    count: number;
     total: number;
+    page: number;
+    pageSize: number;
     hasMore: boolean;
+    nextCursor: string | undefined;
     isLoading: boolean;
+    isFetching: boolean;
     isError: boolean;
     error: Error | null;
-    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<PaginatedResponse<NewsItem>, Error>>;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<ContentListResponse<NewsItem>, Error>>;
 };
 
 /**
- * useContent - Generic content fetching hook
- *
- * When authenticated (isPublicMode = false), fetches content visible to members
- * including public, internal, and members-only content (for supported types).
- *
- * When not authenticated (isPublicMode = true), fetches only public content.
- *
- * @param contentType - The type of content to fetch (e.g., 'news', 'pages', 'events')
- * @param options - Query options for filtering and pagination
- *
- * @example
- * ```tsx
- * // Fetch pages
- * const { data: pages } = useContent('pages')
+ * Fetch a published content collection.
  *
- * // Fetch custom content type
- * const { data: events } = useContent('events', {
- *   status: 'published',
- *   sortBy: 'startDate'
- * })
- * ```
+ * AxCloud owns editorial data and publication. The consuming application owns
+ * layout and rendering. Drafts are intentionally never selectable through
+ * this delivery hook.
  */
 declare function useContent<T extends ContentItem = ContentItem>(contentType: string, options?: ContentQueryOptions): {
     data: T[];
+    count: number;
     total: number;
+    page: number;
+    pageSize: number;
     hasMore: boolean;
+    nextCursor: string | undefined;
     isLoading: boolean;
+    isFetching: boolean;
     isError: boolean;
     error: Error | null;
-    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<PaginatedResponse<T>, Error>>;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<ContentListResponse<T>, Error>>;
 };
 interface ContentItemOptions {
-    /** Force public endpoint even when authenticated */
+    /** Force public delivery even when the visitor is authenticated. */
     publicOnly?: boolean;
     /** Return the requested translation when content has language variants. */
     lang?: string;
 }
-/**
- * useContentItem - Fetch a single content item by ID or slug
- *
- * When authenticated (isPublicMode = false), fetches from member endpoint
- * which can return members-only content (for supported types).
- *
- * When not authenticated (isPublicMode = true), fetches only public content.
- *
- * @param contentType - The type of content (e.g., 'news', 'pages', 'events')
- * @param idOrSlug - The content ID or slug
- * @param options - Optional settings
- *
- * @example
- * ```tsx
- * // Fetch a page by slug
- * const { data: page } = useContentItem('pages', 'about-us', { lang: 'sv' })
- *
- * // Force public endpoint
- * const { data: page } = useContentItem('pages', 'about-us', { publicOnly: true })
- * ```
- */
+/** Fetch one published content item by ID or slug. */
 declare function useContentItem<T extends ContentItem = ContentItem>(contentType: string, idOrSlug: string, options?: ContentItemOptions): {
     data: _tanstack_react_query.NoInfer<T> | null;
     isLoading: boolean;
+    isFetching: boolean;
     isError: boolean;
     error: Error | null;
     refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<_tanstack_react_query.NoInfer<T>, Error>>;
@@ -1362,16 +1381,17 @@ interface PageContentState<T extends ContentItem = ContentItem> extends ContentS
     page: T | null;
     data: T | null;
     isLoading: boolean;
+    isFetching: boolean;
     isError: boolean;
     error: Error | null;
     refetch: () => unknown;
 }
 /**
- * usePageContent - Fetch a website page and expose structured template fields.
+ * Fetch a website page and expose structured template fields.
  *
  * Use `page.content`/`page.blocks` for article-like rich text pages. Use
- * `text('hero.title')`, `list('benefits.items')`, etc. for designed website templates
- * where the frontend owns layout and AxCloud owns content.
+ * `text('hero.title')`, `list('benefits.items')`, etc. for designed website
+ * templates where the frontend owns layout and AxCloud owns content.
  */
 declare function usePageContent<T extends ContentItem = ContentItem>(slug: string, options?: ContentItemOptions): PageContentState<T>;
 
@@ -2158,4 +2178,4 @@ interface LinkedAccountsListProps {
  */
 declare function LinkedAccountsList({ providers, showConnectButtons, className, onUnlink, onLinkInitiated, renderIdentity, renderAvailableProvider, }: LinkedAccountsListProps): react_jsx_runtime.JSX.Element;
 
-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 };
+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 ContentCollectionType, type ContentDetailType, type ContentItem, type ContentListResponse, 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 MyProfileResponse, 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 UpdateMyProfileInput, type UseAuthReturn, type UseLinkedAccountsReturn, type User, type UserApiResponse, type UserOrganizationMembership, type UserOrganizationSection, 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, useUpdateMyProfile, useUser, userHasAllPermissions, userHasAnyPermission, userHasPermission };