@praxium/sdk 0.5.91 → 0.5.94

package/README.md

@@ -2,6 +2,8 @@
 
 Official TypeScript SDK for the [Praxium](https://praxium.nl) platform API. Build tenant websites that display practice data (team, services, FAQ, opening hours) with full locale support.
 
+Learn more on the [Praxium developer platform](https://platform.praxium.nl).
+
 - [Quick Start](#quick-start) — Installation and usage examples
 - [Configuration](#configuration) — Environment variables and tenant routing
 - [Available Methods](#available-methods) — All API endpoints
@@ -31,6 +33,7 @@ const client = createPraxiumClient({
 const hours = await client.getOpeningHours()
 const team = await client.getTeamMembers()
 const faq = await client.getFaq()
+// FAQ category names, questions, and answers are strings in the requested locale.
 ```
 
 All methods return data directly or throw a typed `PraxiumError` on failure (see [Error Handling](#error-handling)).
@@ -39,6 +42,10 @@ All methods return data directly or throw a typed `PraxiumError` on failure (see
 
 Pass `locale: '*'` to receive all translations as objects. Resolve them at render time with `localizeText()`:
 
+When a method has a different response shape in multilingual mode, the SDK exposes that shape with a `Multilingual*` type. For example, `getTeamMembers()` returns `MultilingualTeamMember[]`, and `getFaq()` returns `MultilingualFaqContent`.
+
+`localizeText(text, locale)` resolves values in this order: requested locale, then English, then the first available value, then an empty string.
+
 ```typescript
 import { createPraxiumClient, localizeText } from '@praxium/sdk'
 
@@ -60,6 +67,9 @@ const team = await client.getTeamMembers()
 
 const label = localizeText(team[0].customFields[0].label, 'nl')  // → "Specialisatie"
 const value = localizeText(team[0].customFields[0].value, 'nl')  // → "Sport"
+
+const faq = await client.getFaq()
+const question = localizeText(faq[0].faqs[0].question, 'nl')
 ```
 
 ### Contact Form

package/dist/index.d.ts

@@ -239,7 +239,7 @@ type FaqGroup = {
     faqs: Array<FaqItem>;
 };
 /**
- * FAQ category with bilingual name
+ * FAQ category
  */
 type FaqCategory = {
     /**
@@ -247,11 +247,9 @@ type FaqCategory = {
      */
     id: string;
     /**
-     * Category name per locale
+     * Category name resolved to requested locale
      */
-    name: {
-        [key: string]: string;
-    };
+    name: string;
     /**
      * Display order (ascending)
      */
@@ -266,17 +264,13 @@ type FaqItem = {
      */
     id: string;
     /**
-     * Question text per locale
+     * Question text resolved to requested locale
      */
-    question: {
-        [key: string]: string;
-    };
+    question: string;
     /**
-     * Answer text per locale (may contain HTML)
+     * Answer text resolved to requested locale (may contain HTML)
      */
-    answer: {
-        [key: string]: string;
-    };
+    answer: string;
     /**
      * Parent category UUID
      */
@@ -659,6 +653,39 @@ type MultilingualTeamMember = {
     /** Custom fields with multilingual labels and values */
     customFields: Array<MultilingualCustomField>;
 };
+/** FAQ category in locale='*' mode. */
+type MultilingualFaqCategory = {
+    /** Category UUID */
+    id: string;
+    /** Category name in all available locales */
+    name: MultilingualText;
+    /** Display order (ascending) */
+    order: number;
+};
+/** FAQ item in locale='*' mode. */
+type MultilingualFaqItem = {
+    /** FAQ item UUID */
+    id: string;
+    /** Question text in all available locales */
+    question: MultilingualText;
+    /** Answer text in all available locales (may contain HTML) */
+    answer: MultilingualText;
+    /** Parent category UUID */
+    categoryId: string;
+    /** Display order within category (ascending) */
+    order: number;
+    /** Whether this FAQ item is currently visible */
+    visible: boolean;
+};
+/** FAQ category group in locale='*' mode. */
+type MultilingualFaqGroup = {
+    /** The FAQ category */
+    category: MultilingualFaqCategory;
+    /** FAQ items in this category */
+    faqs: Array<MultilingualFaqItem>;
+};
+/** FAQ content in locale='*' mode. */
+type MultilingualFaqContent = Array<MultilingualFaqGroup>;
 
 /**
  * Supported locale codes for server-side content resolution.
@@ -695,7 +722,6 @@ interface PraxiumClientBase {
     getLocation: () => Promise<Location>;
     getBusinessName: () => Promise<BusinessName>;
     getSocialLinks: () => Promise<SocialLinks>;
-    getFaq: () => Promise<FaqContent>;
     getServiceVariants: () => Promise<PricingVariants>;
     getInsuranceInfo: () => Promise<InsuranceList>;
     getFeatures: () => Promise<FeatureList>;
@@ -706,10 +732,12 @@ interface PraxiumClientBase {
 }
 /** Client for locale-specific responses (locale='nl', 'en', etc.) */
 interface PraxiumClient extends PraxiumClientBase {
+    getFaq: () => Promise<FaqContent>;
     getTeamMembers: () => Promise<TeamMembers>;
 }
 /** Client for multilingual responses (locale='*') */
 interface MultilingualPraxiumClient extends PraxiumClientBase {
+    getFaq: () => Promise<MultilingualFaqContent>;
     getTeamMembers: () => Promise<MultilingualTeamMember[]>;
 }
 /** Multilingual mode: returns MultilingualTeamMember[] (use localizeText() helper for resolution) */
@@ -863,4 +891,4 @@ declare function getCustomField(member: MultilingualTeamMember, identifier: stri
  */
 declare function localizeText(text: MultilingualText | null | undefined, locale: SupportedLocale): string;
 
-export { API_KEY_PREFIX, API_KEY_PREFIX_WITH_SEPARATOR, API_KEY_SEPARATOR, type ApiError, type BilingualText, type BookableService, type BookableServices, type BookableVariantInfo, type BusinessName, type ClientLocale, type ContactDetails, type ContactFormResult, type CustomField, type FaqCategory, type FaqContent, type FaqGroup, type FaqItem, type FeatureItem, type FeatureList, type InsuranceInfo, type InsuranceList, type Location, type MultilingualCustomField, type MultilingualPraxiumClient, type MultilingualTeamMember, type MultilingualText, type OpeningHours, type PaymentMethod, type PaymentMethodList, type PolicyInfo, type PolicyList, PraxiumAuthError, type PraxiumClient, type PraxiumClientConfig, PraxiumError, PraxiumForbiddenError, PraxiumNotFoundError, PraxiumRateLimitError, PraxiumValidationError, type PricingVariant, type PricingVariants, type PublicDaySchedule, type PublicTeamMember, type ServiceCategoryInfo, type SocialLinks, type SupportedLocale, type TeamMembers, type ValidationDetail, createPraxiumClient, extractTenantSlugFromApiKey, getCustomField, getCustomFieldValue, localizeText };
+export { API_KEY_PREFIX, API_KEY_PREFIX_WITH_SEPARATOR, API_KEY_SEPARATOR, type ApiError, type BilingualText, type BookableService, type BookableServices, type BookableVariantInfo, type BusinessName, type ClientLocale, type ContactDetails, type ContactFormResult, type CustomField, type FaqCategory, type FaqContent, type FaqGroup, type FaqItem, type FeatureItem, type FeatureList, type InsuranceInfo, type InsuranceList, type Location, type MultilingualCustomField, type MultilingualFaqCategory, type MultilingualFaqContent, type MultilingualFaqGroup, type MultilingualFaqItem, type MultilingualPraxiumClient, type MultilingualTeamMember, type MultilingualText, type OpeningHours, type PaymentMethod, type PaymentMethodList, type PolicyInfo, type PolicyList, PraxiumAuthError, type PraxiumClient, type PraxiumClientConfig, PraxiumError, PraxiumForbiddenError, PraxiumNotFoundError, PraxiumRateLimitError, PraxiumValidationError, type PricingVariant, type PricingVariants, type PublicDaySchedule, type PublicTeamMember, type ServiceCategoryInfo, type SocialLinks, type SupportedLocale, type TeamMembers, type ValidationDetail, createPraxiumClient, extractTenantSlugFromApiKey, getCustomField, getCustomFieldValue, localizeText };

package/dist/index.js

@@ -981,7 +981,6 @@ function createPraxiumClient(config) {
     getBusinessName: () => getBusinessName({ client: clientInstance, path }).then(unwrapOrThrow),
     getSocialLinks: () => getSocialLinks({ client: clientInstance, path }).then(unwrapOrThrow),
     // ─── Content Endpoints ───
-    getFaq: () => getFaq({ client: clientInstance, path }).then(unwrapOrThrow),
     getServiceVariants: () => getServiceVariants({ client: clientInstance, path }).then(unwrapOrThrow),
     getInsuranceInfo: () => getInsuranceInfo({ client: clientInstance, path }).then(unwrapOrThrow),
     getFeatures: () => getFeatures({ client: clientInstance, path }).then(unwrapOrThrow),
@@ -994,11 +993,13 @@ function createPraxiumClient(config) {
   if (config.locale === "*") {
     return {
       ...baseMethods,
+      getFaq: () => getFaq({ client: clientInstance, path }).then(unwrapOrThrow),
       getTeamMembers: () => getTeamMembers({ client: clientInstance, path }).then(unwrapOrThrow)
     };
   }
   return {
     ...baseMethods,
+    getFaq: () => getFaq({ client: clientInstance, path }).then(unwrapOrThrow),
     getTeamMembers: () => getTeamMembers({ client: clientInstance, path }).then(unwrapOrThrow)
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@praxium/sdk",
-  "version": "0.5.91",
+  "version": "0.5.94",
   "description": "Official TypeScript SDK for the Praxium platform API",
   "type": "module",
   "exports": {