@praxium/sdk 0.2.22 → 0.3.31

package/dist/index.d.ts

@@ -179,6 +179,19 @@ type SocialLinks = {
  * List of team members visible on the public team page
  */
 type TeamMembers = Array<PublicTeamMember>;
+/**
+ * Custom field exposed on the public team API
+ */
+type CustomField = {
+    /** Field identifier (snake_case) */
+    identifier: string;
+    /** Custom field type (e.g., STRING, LONG_TEXT, SEARCHABLE_LIST) */
+    type: string;
+    /** Localized field label */
+    label: LocalizedText;
+    /** Resolved field value (type depends on field.type) */
+    value: unknown;
+};
 /**
  * Public team member profile
  */
@@ -196,30 +209,9 @@ type PublicTeamMember = {
      */
     publicImage: string;
     /**
-     * List of specializations
-     */
-    specializations: Array<LocalizedSpecialization>;
-    /**
-     * Staff biography in NL and EN
-     */
-    bio: BilingualText | null;
-    /**
-     * BIG registration number (Dutch healthcare registration)
-     */
-    bigNumber: string | null;
-};
-/**
- * Specialization with bilingual names
- */
-type LocalizedSpecialization = {
-    /**
-     * Dutch specialization name
-     */
-    nl: string;
-    /**
-     * English specialization name
+     * Custom fields assigned to the public-team API access profile
      */
-    en: string;
+    customFields: Array<CustomField>;
 };
 /**
  * Bilingual text with Dutch (nl) and English (en) translations
@@ -234,6 +226,8 @@ type BilingualText = {
      */
     en: string;
 };
+/** Text with locale-specific values. Keys are locale codes (e.g., 'nl', 'en'). */
+type LocalizedText = Record<string, string>;
 /**
  * FAQs grouped by category, ordered by category.order then faq.order
  */
@@ -628,6 +622,8 @@ interface TenantClientConfig {
     locale: string;
 }
 declare function createTenantClient(config: TenantClientConfig): {
+    /** Resolve a LocalizedText to a string using the client's configured locale. */
+    localize: (text: LocalizedText | null | undefined) => string;
     getOpeningHours: () => Promise<OpeningHours>;
     getContactDetails: () => Promise<ContactDetails>;
     getLocation: () => Promise<Location>;
@@ -704,4 +700,46 @@ declare class PraxiumRateLimitError extends PraxiumError {
     constructor(errorCode: string, message: string);
 }
 
-export { type ApiError, type BilingualText, type BookableService, type BookableServices, type BookableVariantInfo, type BusinessName, type ContactDetails, type ContactFormResult, type FaqCategory, type FaqContent, type FaqGroup, type FaqItem, type FeatureItem, type FeatureList, type InsuranceInfo, type InsuranceList, type LocalizedSpecialization, type Location, type OpeningHours, type PaymentMethod, type PaymentMethodList, type PolicyInfo, type PolicyList, PraxiumAuthError, PraxiumError, PraxiumForbiddenError, PraxiumNotFoundError, PraxiumRateLimitError, PraxiumValidationError, type PricingVariant, type PricingVariants, type PublicDaySchedule, type PublicTeamMember, type ServiceCategoryInfo, type SocialLinks, type TeamMembers, type TenantClient, type TenantClientConfig, type ValidationDetail, createTenantClient };
+/**
+ * Helper functions for working with the public team API custom fields.
+ */
+
+/**
+ * Get a custom field value by identifier from a team member's custom fields.
+ *
+ * **Type safety warning:** The generic `T` is a cast (`as T`) — the caller is
+ * responsible for ensuring `T` matches the actual runtime value shape for the
+ * given field type. No runtime validation is performed.
+ *
+ * Runtime value shapes by custom field type:
+ * - `STRING`           → `string`
+ * - `LONG_TEXT`        → `string`
+ * - `NUMBER`           → `number`
+ * - `BOOLEAN`          → `boolean`
+ * - `SINGLE_SELECT`    → `BilingualText` (`{ nl: string; en: string }`)
+ * - `MULTI_SELECT`     → `BilingualText[]`
+ * - `SEARCHABLE_LIST`  → `BilingualText[]`
+ * - `DATE`             → `string` (ISO 8601 date)
+ *
+ * @example
+ * ```ts
+ * // Caller must match T to the field's actual type:
+ * const specs = getCustomFieldValue<BilingualText[]>(member, 'specializations')
+ * const bigNr = getCustomFieldValue<string>(member, 'big_number')
+ * ```
+ *
+ * @param member - Public team member
+ * @param identifier - Field identifier to look up
+ * @returns The field value cast to `T`, or `null` if no field with that identifier exists
+ */
+declare function getCustomFieldValue<T = unknown>(member: PublicTeamMember, identifier: string): T | null;
+/**
+ * Get a custom field by identifier.
+ *
+ * @param member - Public team member
+ * @param identifier - Field identifier to look up
+ * @returns The full custom field, or undefined if not found
+ */
+declare function getCustomField(member: PublicTeamMember, identifier: string): CustomField | undefined;
+
+export { type ApiError, type BilingualText, type BookableService, type BookableServices, type BookableVariantInfo, type BusinessName, type ContactDetails, type ContactFormResult, type CustomField, type FaqCategory, type FaqContent, type FaqGroup, type FaqItem, type FeatureItem, type FeatureList, type InsuranceInfo, type InsuranceList, type LocalizedText, type Location, type OpeningHours, type PaymentMethod, type PaymentMethodList, type PolicyInfo, type PolicyList, PraxiumAuthError, PraxiumError, PraxiumForbiddenError, PraxiumNotFoundError, PraxiumRateLimitError, PraxiumValidationError, type PricingVariant, type PricingVariants, type PublicDaySchedule, type PublicTeamMember, type ServiceCategoryInfo, type SocialLinks, type TeamMembers, type TenantClient, type TenantClientConfig, type ValidationDetail, createTenantClient, getCustomField, getCustomFieldValue };

package/dist/index.js

@@ -928,6 +928,19 @@ var STATUS_ERROR_MAP = {
   429: PraxiumRateLimitError
 };
 
+// src/helpers.ts
+function getCustomFieldValue(member, identifier) {
+  const field = member.customFields.find((f) => f.identifier === identifier);
+  return field ? field.value : null;
+}
+function getCustomField(member, identifier) {
+  return member.customFields.find((f) => f.identifier === identifier);
+}
+function getLocalizedText(text, locale) {
+  if (!text) return "";
+  return text[locale] || text["en"] || Object.values(text)[0] || "";
+}
+
 // src/tenant-client.ts
 function unwrapOrThrow(result) {
   if (result.data !== void 0 && result.error === void 0) {
@@ -957,6 +970,9 @@ function createTenantClient(config) {
   });
   const path = { tenantSlug: config.tenantSlug };
   return {
+    // ─── Locale Helper ───
+    /** Resolve a LocalizedText to a string using the client's configured locale. */
+    localize: (text) => getLocalizedText(text, config.locale),
     // ─── Layout Endpoints ───
     getOpeningHours: () => getOpeningHours({ client: clientInstance, path }).then(unwrapOrThrow),
     getContactDetails: () => getContactDetails({ client: clientInstance, path }).then(unwrapOrThrow),
@@ -983,5 +999,7 @@ export {
   PraxiumNotFoundError,
   PraxiumRateLimitError,
   PraxiumValidationError,
-  createTenantClient
+  createTenantClient,
+  getCustomField,
+  getCustomFieldValue
 };

package/package.json

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