@praxium/sdk 0.3.42 → 0.3.49

package/README.md

@@ -10,14 +10,15 @@ npm install @praxium/sdk
 
 ## Usage
 
+### Locale-Specific Mode
+
 ```typescript
-import { createTenantClient } from '@praxium/sdk'
+import { createPraxiumClient } from '@praxium/sdk'
 
-const client = createTenantClient({
+const client = createPraxiumClient({
   baseUrl: process.env.PRAXIUM_API_URL!,   // 'https://platform.praxium.nl'
-  apiKey: process.env.PRAXIUM_API_KEY!,     // HMAC key: 'hmac_v1_mypractice_1234567890_abc...'
-  tenantSlug: 'mypractice',                 // must match the slug in the API key
-  locale: 'en',                             // 'en' (English) or 'nl' (Dutch)
+  apiKey: process.env.PRAXIUM_API_KEY!,     // tenant slug extracted from key automatically
+  locale: 'nl',                             // 'nl' | 'en' | '*' (multilingual)
 })
 
 // Returns data directly — throws PraxiumError on failure
@@ -25,6 +26,32 @@ const hours = await client.getOpeningHours()
 const team = await client.getTeamMembers()
 ```
 
+### Multilingual Mode
+
+```typescript
+import { createPraxiumClient, localizeText } from '@praxium/sdk'
+
+const client = createPraxiumClient({
+  baseUrl: process.env.PRAXIUM_API_URL!,
+  apiKey: process.env.PRAXIUM_API_KEY!,
+  locale: '*',  // returns all translations
+})
+
+const team = await client.getTeamMembers()
+// Returns MultilingualTeamMember[] — labels/values are { nl: "...", en: "..." } objects:
+// {
+//   name: "Dr. Jan de Vries",
+//   role: "Fysiotherapeut",
+//   customFields: [
+//     { label: { nl: "Specialisatie", en: "Specialization" }, value: { nl: "Sport", en: "Sports" } }
+//   ]
+// }
+
+// Resolve multilingual text to a specific locale at render time
+const label = localizeText(team[0].customFields[0].label, 'nl')  // → "Specialisatie"
+const value = localizeText(team[0].customFields[0].value, 'nl')  // → "Sport"
+```
+
 ## Next.js Revalidation
 
 Optional utilities for ISR cache revalidation (requires `next` as peer dependency):

package/dist/index.d.ts

@@ -660,18 +660,25 @@ type SupportedLocale = 'nl' | 'en';
  * - `'*'` — server returns all translations (multilingual mode)
  */
 type ClientLocale = SupportedLocale | '*';
-interface TenantClientConfig {
+/**
+ * Extract the tenant slug from a profile-scoped API key.
+ *
+ * Key format: hmac_v1_{tenantSlug}_{profileSlug}_{timestamp}_{signature}
+ * Parts:      [0]hmac [1]v1 [2]tenantSlug [3]profileSlug [4]timestamp [5]signature
+ *
+ * @throws Error if key format is invalid (wrong prefix or insufficient parts)
+ */
+declare function extractTenantSlugFromApiKey(apiKey: string): string;
+interface PraxiumClientConfig {
     /** Platform base URL (e.g., 'https://platform.praxium.nl') */
     baseUrl: string;
-    /** HMAC-signed API key (format: hmac_v1_{slug}_{timestamp}_{signature}) */
+    /** HMAC-signed API key (format: hmac_v1_{tenantSlug}_{profileSlug}_{timestamp}_{signature}) */
     apiKey: string;
-    /** Tenant identifier slug (must match the slug in the API key) */
-    tenantSlug: string;
     /** Locale for server-side content resolution */
     locale: ClientLocale;
 }
 /** Shared methods available on both client types */
-interface TenantClientBase {
+interface PraxiumClientBase {
     getOpeningHours: () => Promise<OpeningHours>;
     getContactDetails: () => Promise<ContactDetails>;
     getLocation: () => Promise<Location>;
@@ -687,24 +694,24 @@ interface TenantClientBase {
     submitContactForm: (body: SubmitContactFormData['body']) => Promise<ContactFormResult>;
 }
 /** Client for locale-specific responses (locale='nl', 'en', etc.) */
-interface TenantClient extends TenantClientBase {
+interface PraxiumClient extends PraxiumClientBase {
     getTeamMembers: () => Promise<TeamMembers>;
 }
 /** Client for multilingual responses (locale='*') */
-interface MultilingualTenantClient extends TenantClientBase {
+interface MultilingualPraxiumClient extends PraxiumClientBase {
     getTeamMembers: () => Promise<MultilingualTeamMember[]>;
 }
 /** Multilingual mode: returns MultilingualTeamMember[] (use localizeText() helper for resolution) */
-declare function createTenantClient(config: TenantClientConfig & {
+declare function createPraxiumClient(config: PraxiumClientConfig & {
     locale: '*';
-}): MultilingualTenantClient;
+}): MultilingualPraxiumClient;
 /** Locale-specific mode: returns PublicTeamMember[] with resolved labels/values */
-declare function createTenantClient(config: TenantClientConfig): TenantClient;
+declare function createPraxiumClient(config: PraxiumClientConfig): PraxiumClient;
 
 /**
  * Typed error hierarchy for the Praxium SDK.
  *
- * Every method on `TenantClient` throws one of these errors when the
+ * Every method on `PraxiumClient` throws one of these errors when the
  * API returns a non-2xx response. Consumers can catch a specific
  * subclass (e.g. `PraxiumNotFoundError`) or the base `PraxiumError`.
  *
@@ -831,4 +838,4 @@ declare function getCustomField(member: MultilingualTeamMember, identifier: stri
  */
 declare function localizeText(text: MultilingualText | null | undefined, locale: SupportedLocale): string;
 
-export { 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 MultilingualTeamMember, type MultilingualTenantClient, type MultilingualText, 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 SupportedLocale, type TeamMembers, type TenantClient, type TenantClientConfig, type ValidationDetail, createTenantClient, getCustomField, getCustomFieldValue, localizeText };
+export { 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 };

package/dist/index.js

@@ -929,6 +929,19 @@ var STATUS_ERROR_MAP = {
 };
 
 // src/tenant-client.ts
+var API_KEY_PREFIX = "hmac_v1";
+var API_KEY_SEPARATOR = "_";
+function extractTenantSlugFromApiKey(apiKey) {
+  const parts = apiKey.split(API_KEY_SEPARATOR);
+  if (parts.length < 6 || `${parts[0]}${API_KEY_SEPARATOR}${parts[1]}` !== API_KEY_PREFIX) {
+    throw new PraxiumError(
+      400,
+      "INVALID_API_KEY_FORMAT",
+      `API key must start with '${API_KEY_PREFIX}' and contain at least 6 segments. Format: hmac_v1_{tenantSlug}_{profileSlug}_{timestamp}_{signature}`
+    );
+  }
+  return parts[2];
+}
 function unwrapOrThrow(result) {
   if (result.data !== void 0 && result.error === void 0) {
     return result.data.data;
@@ -944,7 +957,8 @@ function unwrapOrThrow(result) {
   }
   throw new PraxiumError(status, errorCode, message, details);
 }
-function createTenantClient(config) {
+function createPraxiumClient(config) {
+  const tenantSlug = extractTenantSlugFromApiKey(config.apiKey);
   const clientInstance = createClient(
     createConfig({
       baseUrl: config.baseUrl,
@@ -955,7 +969,7 @@ function createTenantClient(config) {
     request.headers.set("Accept-Language", config.locale);
     return request;
   });
-  const path = { tenantSlug: config.tenantSlug };
+  const path = { tenantSlug };
   const baseMethods = {
     // ─── Layout Endpoints ───
     getOpeningHours: () => getOpeningHours({ client: clientInstance, path }).then(unwrapOrThrow),
@@ -1005,7 +1019,8 @@ export {
   PraxiumNotFoundError,
   PraxiumRateLimitError,
   PraxiumValidationError,
-  createTenantClient,
+  createPraxiumClient,
+  extractTenantSlugFromApiKey,
   getCustomField,
   getCustomFieldValue,
   localizeText

package/package.json

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