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

package/README.md

@@ -53,7 +53,8 @@ function App() {
       auth0={{
         domain: "auth.axcloud.app",
         clientId: "your-client-id",
-        redirectUri: window.location.origin
+        redirectUri: window.location.origin,
+        organization: "org_auth0_..." // Optional Auth0 Organization ID for invite-only member sites
       }}
     >
       <Router>
@@ -64,6 +65,10 @@ function App() {
 }
 ```
 
+`orgId` is the AxCloud organization ID used by CMS APIs, for example `org_ba81807b`.
+`auth0.organization` is the Auth0 Organization ID used during login, for example `org_o960yILn77d4vY6u`.
+Set `auth0.organization` for invite-only customer member sites so Universal Login is scoped to that customer organization.
+
 ### 2. Fetch content
 
 ```tsx
@@ -87,10 +92,10 @@ function NewsPage() {
 
 > **Content visibility:** When the user is authenticated, `useNews`, `useContent('pages')`, and `useContent('events')` automatically fetch **public + internal + members-only** content based on the user's organization membership. For anonymous users, only public content is returned.
 
-Pages can be stored once in AxCloud with translations and requested per language:
+Pages and news can be stored once in AxCloud with translations and requested per language:
 
 ```tsx
-import { useContentItem } from '@axcode/axcloud-sdk'
+import { useContentItem, useNews } from '@axcode/axcloud-sdk'
 
 function AboutPage({ locale }: { locale: 'sv' | 'en' }) {
   const { data: page } = useContentItem('pages', 'about-us', {
@@ -100,6 +105,12 @@ function AboutPage({ locale }: { locale: 'sv' | 'en' }) {
 
   return <h1>{page?.title}</h1>
 }
+
+function NewsList({ locale }: { locale: 'sv' | 'en' }) {
+  const { data: news } = useNews({ lang: locale })
+
+  return news.map(item => <article key={item.id}>{item.title}</article>)
+}
 ```
 
 ### 3. Add authentication
@@ -133,6 +144,27 @@ function MemberArea() {
 }
 ```
 
+The SDK keeps verification UI inside the product site. Render your own branded
+notice when `needsEmailVerification` is true:
+
+```tsx
+const {
+  needsEmailVerification,
+  requestEmailVerification,
+  refreshUser,
+} = useAuth()
+
+if (needsEmailVerification) {
+  // Render the product's own verification notice.
+}
+
+await requestEmailVerification({ returnTo: window.location.href })
+await refreshUser()
+```
+
+The API resolves the recipient and organization from the authenticated token.
+Return URLs are restricted to the organization's configured member site.
+
 ### 4. Use sections
 
 ```tsx
@@ -215,7 +247,35 @@ function HeroImage() {
 
 > **Note:** Media URLs are signed S3 URLs that expire after 1 hour. The SDK automatically refreshes them before expiry (staleTime: 30 min).
 
-### 6. Gate features by module
+### 6. Fetch public documents
+
+```tsx
+import { useDocuments, useDocumentDownload } from '@axcode/axcloud-sdk'
+
+function PublicDocuments() {
+  const { documents, isLoading } = useDocuments({ tags: ['handbook'], limit: 20 })
+
+  if (isLoading) return <Skeleton />
+  return (
+    <ul>
+      {documents.map(doc => (
+        <li key={doc.document_id}>
+          <DocumentLink documentId={doc.document_id} title={doc.title} />
+        </li>
+      ))}
+    </ul>
+  )
+}
+
+function DocumentLink({ documentId, title }: { documentId: string; title: string }) {
+  const { documentUrl } = useDocumentDownload(documentId)
+  return documentUrl ? <a href={documentUrl}>{title}</a> : <span>{title}</span>
+}
+```
+
+Only documents with `status: "published"` and `audience: "public"` are exposed through SDK document hooks.
+
+### 7. Gate features by module
 
 ```tsx
 import { ModuleGate, useOrg } from '@axcode/axcloud-sdk'
@@ -249,7 +309,7 @@ function Dashboard() {
 
 | Hook | Description |
 |------|-------------|
-| `useAuth()` | Login/logout with Auth0 Universal Login |
+| `useAuth()` | Login/logout, email-verification state, resend, and profile refresh |
 | `useUser()` | Fetch current user with role and permissions |
 | `useOrg()` | Fetch organization info and check modules |
 | `useNews(options?)` | Fetch news articles. Returns public + internal + members content when authenticated. |
@@ -261,6 +321,8 @@ function Dashboard() {
 | `useMedia(mediaId)` | Fetch specific media file URL |
 | `useAvatar(userId)` | Fetch user avatar URL |
 | `useMediaList(type)` | List media files |
+| `useDocuments(options?)` | List published public documents |
+| `useDocumentDownload(documentId)` | Fetch a signed document download URL |
 
 ### Content Query Options