@axcode/axcloud-sdk 0.1.5 → 0.1.6

package/dist/index.d.mts

@@ -216,6 +216,8 @@ interface ContentTranslation {
     slug: string;
     description?: string;
     blocks: ContentBlock[];
+    /** Structured website/template fields for this language. */
+    fields?: Record<string, unknown>;
     metaTitle?: string;
     metaDescription?: string;
     keywords?: string[];
@@ -232,6 +234,10 @@ interface ContentItem {
     content?: string;
     description?: string;
     blocks?: ContentBlock[];
+    /** Template identifier used by websites, e.g. "home" or "landing". */
+    template?: string;
+    /** Structured website/template fields. Frontends own layout and read these values by key. */
+    fields?: Record<string, unknown>;
     excerpt?: string;
     author?: {
         id: string;
@@ -361,6 +367,24 @@ interface MediaListResponse {
     prefix: string;
 }
 
+type ContentSlotValue = string | number | boolean | null | undefined | string[] | Record<string, unknown> | unknown[];
+type ContentSlotMap = Record<string, ContentSlotValue>;
+interface ContentSlotImage {
+    url: string;
+    alt?: string;
+    caption?: string;
+}
+interface ContentSlotReader {
+    fields: ContentSlotMap;
+    value<T = ContentSlotValue>(key: string, fallback?: T): ContentSlotValue | T;
+    text(key: string, fallback?: string): string;
+    html(key: string, fallback?: string): string;
+    list(key: string, fallback?: string[]): string[];
+    image(key: string, fallback?: ContentSlotImage): ContentSlotImage | undefined;
+}
+declare function getContentSlotMap(content?: Pick<ContentItem, 'fields' | 'blocks'> | null): ContentSlotMap;
+declare function createContentSlotReader(content?: Pick<ContentItem, 'fields' | 'blocks'> | null): ContentSlotReader;
+
 /**
  * AxCloud Forms Module
  *
@@ -896,6 +920,22 @@ declare function useContentItem<T extends ContentItem = ContentItem>(contentType
     error: Error | null;
     refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<_tanstack_react_query.NoInfer<T>, Error>>;
 };
+interface PageContentState<T extends ContentItem = ContentItem> extends ContentSlotReader {
+    page: T | null;
+    data: T | null;
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: () => unknown;
+}
+/**
+ * usePageContent - 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.
+ */
+declare function usePageContent<T extends ContentItem = ContentItem>(slug: string, options?: ContentItemOptions): PageContentState<T>;
 
 interface SectionWithMembers extends Section {
     members?: User[];
@@ -1529,4 +1569,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 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 PaginatedResponse, ProtectedRoute, type Section, type SectionPermissions, type SignedMediaUrl, type SystemRole, type UseLinkedAccountsReturn, type User, type UserRole, createClient, createFormHelper, getClient, isAxCloudError, submitForm, useAuth, useAvatar, useAxCloudContext, useBranding, useContent, useContentItem, useFormStats, useForms, useLinkedAccounts, useLogo, useMedia, useMediaList, useModuleAccess, useMySection, useNews, useOrg, useSections, useUpdateFormSubmission, useUser, userHasAllPermissions, userHasAnyPermission, userHasPermission };
+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 };

package/dist/index.d.ts

@@ -216,6 +216,8 @@ interface ContentTranslation {
     slug: string;
     description?: string;
     blocks: ContentBlock[];
+    /** Structured website/template fields for this language. */
+    fields?: Record<string, unknown>;
     metaTitle?: string;
     metaDescription?: string;
     keywords?: string[];
@@ -232,6 +234,10 @@ interface ContentItem {
     content?: string;
     description?: string;
     blocks?: ContentBlock[];
+    /** Template identifier used by websites, e.g. "home" or "landing". */
+    template?: string;
+    /** Structured website/template fields. Frontends own layout and read these values by key. */
+    fields?: Record<string, unknown>;
     excerpt?: string;
     author?: {
         id: string;
@@ -361,6 +367,24 @@ interface MediaListResponse {
     prefix: string;
 }
 
+type ContentSlotValue = string | number | boolean | null | undefined | string[] | Record<string, unknown> | unknown[];
+type ContentSlotMap = Record<string, ContentSlotValue>;
+interface ContentSlotImage {
+    url: string;
+    alt?: string;
+    caption?: string;
+}
+interface ContentSlotReader {
+    fields: ContentSlotMap;
+    value<T = ContentSlotValue>(key: string, fallback?: T): ContentSlotValue | T;
+    text(key: string, fallback?: string): string;
+    html(key: string, fallback?: string): string;
+    list(key: string, fallback?: string[]): string[];
+    image(key: string, fallback?: ContentSlotImage): ContentSlotImage | undefined;
+}
+declare function getContentSlotMap(content?: Pick<ContentItem, 'fields' | 'blocks'> | null): ContentSlotMap;
+declare function createContentSlotReader(content?: Pick<ContentItem, 'fields' | 'blocks'> | null): ContentSlotReader;
+
 /**
  * AxCloud Forms Module
  *
@@ -896,6 +920,22 @@ declare function useContentItem<T extends ContentItem = ContentItem>(contentType
     error: Error | null;
     refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<_tanstack_react_query.NoInfer<T>, Error>>;
 };
+interface PageContentState<T extends ContentItem = ContentItem> extends ContentSlotReader {
+    page: T | null;
+    data: T | null;
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: () => unknown;
+}
+/**
+ * usePageContent - 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.
+ */
+declare function usePageContent<T extends ContentItem = ContentItem>(slug: string, options?: ContentItemOptions): PageContentState<T>;
 
 interface SectionWithMembers extends Section {
     members?: User[];
@@ -1529,4 +1569,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 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 PaginatedResponse, ProtectedRoute, type Section, type SectionPermissions, type SignedMediaUrl, type SystemRole, type UseLinkedAccountsReturn, type User, type UserRole, createClient, createFormHelper, getClient, isAxCloudError, submitForm, useAuth, useAvatar, useAxCloudContext, useBranding, useContent, useContentItem, useFormStats, useForms, useLinkedAccounts, useLogo, useMedia, useMediaList, useModuleAccess, useMySection, useNews, useOrg, useSections, useUpdateFormSubmission, useUser, userHasAllPermissions, userHasAnyPermission, userHasPermission };
+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 };

package/dist/index.js

@@ -238,6 +238,88 @@ function getClient(key) {
   throw new Error("AxCloud client not found. Make sure AxCloudProvider is mounted and use useAxCloudContext() to get the client.");
 }
 
+// src/core/contentSlots.ts
+var SLOT_ATTRIBUTE_KEYS = ["slot", "field", "key", "name"];
+function getContentSlotMap(content) {
+  const fields = isRecord(content?.fields) ? { ...content?.fields } : {};
+  for (const block of content?.blocks || []) {
+    const slot = getBlockSlot(block);
+    if (!slot) continue;
+    fields[slot] = blockToSlotValue(block);
+  }
+  return fields;
+}
+function createContentSlotReader(content) {
+  const fields = getContentSlotMap(content);
+  const value = (key, fallback) => {
+    return key in fields ? fields[key] : fallback;
+  };
+  return {
+    fields,
+    value,
+    text: (key, fallback = "") => stringifySlotValue(value(key, fallback)),
+    html: (key, fallback = "") => stringifySlotValue(value(key, fallback)),
+    list: (key, fallback = []) => slotValueToList(value(key, fallback)),
+    image: (key, fallback) => slotValueToImage(value(key, fallback))
+  };
+}
+function getBlockSlot(block) {
+  const attributes = block.attributes || {};
+  for (const key of SLOT_ATTRIBUTE_KEYS) {
+    const value = attributes[key];
+    if (typeof value === "string" && value.trim()) return value.trim();
+  }
+  return void 0;
+}
+function blockToSlotValue(block) {
+  if (block.attributes && "value" in block.attributes) {
+    return block.attributes.value;
+  }
+  if (block.type === "list") {
+    return Array.isArray(block.items) ? block.items : [];
+  }
+  if (block.type === "image" && block.url) {
+    return {
+      url: block.url,
+      alt: block.alt,
+      caption: block.caption
+    };
+  }
+  return block.content ?? "";
+}
+function stringifySlotValue(value) {
+  if (value === void 0 || value === null) return "";
+  if (typeof value === "string") return value;
+  if (typeof value === "number" || typeof value === "boolean") return String(value);
+  if (Array.isArray(value)) return value.map((item) => stringifySlotValue(item)).filter(Boolean).join("\n");
+  return "";
+}
+function slotValueToList(value) {
+  if (Array.isArray(value)) {
+    return value.map((item) => stringifySlotValue(item)).filter(Boolean);
+  }
+  if (typeof value === "string") {
+    return value.split(/\r?\n/).map((item) => item.trim()).filter(Boolean);
+  }
+  return [];
+}
+function slotValueToImage(value) {
+  if (isRecord(value) && typeof value.url === "string") {
+    return {
+      url: value.url,
+      alt: typeof value.alt === "string" ? value.alt : void 0,
+      caption: typeof value.caption === "string" ? value.caption : void 0
+    };
+  }
+  if (typeof value === "string" && value) {
+    return { url: value };
+  }
+  return void 0;
+}
+function isRecord(value) {
+  return !!value && typeof value === "object" && !Array.isArray(value);
+}
+
 // src/core/types.ts
 function userHasPermission(user, permission) {
   if (user.permissions && user.permissions.length > 0) {
@@ -791,6 +873,15 @@ function useContentItem(contentType, idOrSlug, options = {}) {
     refetch: query.refetch
   };
 }
+function usePageContent(slug, options = {}) {
+  const state = useContentItem("pages", slug, options);
+  const reader = react.useMemo(() => createContentSlotReader(state.data), [state.data]);
+  return {
+    ...state,
+    page: state.data,
+    ...reader
+  };
+}
 function useMySection(options = {}) {
   const { includeMembers = true } = options;
   const { isAuthenticated } = auth0React.useAuth0();
@@ -1319,8 +1410,10 @@ exports.LogoutButton = LogoutButton;
 exports.ModuleGate = ModuleGate;
 exports.ProtectedRoute = ProtectedRoute;
 exports.createClient = createClient;
+exports.createContentSlotReader = createContentSlotReader;
 exports.createFormHelper = createFormHelper;
 exports.getClient = getClient;
+exports.getContentSlotMap = getContentSlotMap;
 exports.isAxCloudError = isAxCloudError;
 exports.submitForm = submitForm;
 exports.useAuth = useAuth;
@@ -1339,6 +1432,7 @@ exports.useModuleAccess = useModuleAccess;
 exports.useMySection = useMySection;
 exports.useNews = useNews;
 exports.useOrg = useOrg;
+exports.usePageContent = usePageContent;
 exports.useSections = useSections;
 exports.useUpdateFormSubmission = useUpdateFormSubmission;
 exports.useUser = useUser;