@praxium/sdk 0.4.83 → 0.4.87

package/README.md

@@ -73,6 +73,7 @@ const result = await client.submitContactForm({
   phone: '+31612345678',
   subject: 'Appointment request',
   message: 'I would like to book an appointment.',
+  acceptTerms: true,  // required — must reflect the visitor's explicit consent
 })
 // → { success: true, emailStatus: 'sent' }
 ```
@@ -86,7 +87,7 @@ Your website needs two environment variables to connect to the Praxium platform,
 | Variable | Purpose | Example |
 |----------|---------|---------|
 | `PRAXIUM_API_URL` | Your tenant's admin portal URL. The SDK sends API requests to this host. | `https://mypractice.admin.praxium.nl` |
-| `PRAXIUM_API_KEY` | HMAC API key for authentication. Generated in the admin portal under API Profiles. The tenant slug is embedded in the key — no need to configure it separately. | `praxium_v1_mypractice_default_17..._abc...` |
+| `PRAXIUM_API_KEY` | HMAC API key for authentication. Generated in the admin portal under API Profiles. The tenant slug AND the API profile slug are both embedded in the key — no need to configure them separately. | `praxium_v1_mypractice_public-team_17..._abc...` |
 
 **Optional (only if using ISR revalidation webhooks):**
 
@@ -97,7 +98,7 @@ Your website needs two environment variables to connect to the Praxium platform,
 ```bash
 # .env.local
 PRAXIUM_API_URL="https://mypractice.admin.praxium.nl"
-PRAXIUM_API_KEY="praxium_v1_mypractice_default_1234567890_abcdef..."
+PRAXIUM_API_KEY="praxium_v1_mypractice_public-team_1234567890_abcdef..."
 PRAXIUM_WEBHOOK_SECRET="your-webhook-secret-from-admin-portal"  # optional
 ```
 

package/dist/index.d.ts

@@ -674,7 +674,7 @@ type ClientLocale = SupportedLocale | '*';
 /**
  * Extract the tenant slug from a profile-scoped API key.
  *
- * Key format: praxium_v1_{tenantSlug}_{profileSlug}_{timestamp}_{signature}
+ * Key format: `${API_KEY_PREFIX}_{tenantSlug}_{profileSlug}_{timestamp}_{signature}`
  * Parts:      [0]praxium [1]v1 [2]tenantSlug [3]profileSlug [4]timestamp [5]signature
  *
  * @throws Error if key format is invalid (wrong prefix or insufficient parts)
@@ -719,6 +719,20 @@ declare function createPraxiumClient(config: PraxiumClientConfig & {
 /** Locale-specific mode: returns PublicTeamMember[] with resolved labels/values */
 declare function createPraxiumClient(config: PraxiumClientConfig): PraxiumClient;
 
+/** Version-prefixed identifier at the start of every Praxium API key. */
+declare const API_KEY_PREFIX: "praxium_v1";
+/** Separator used between all key segments. */
+declare const API_KEY_SEPARATOR: "_";
+/**
+ * Convenience composition: `praxium_v1_` (prefix + separator).
+ *
+ * Use this when validating that a string starts with the full Praxium API
+ * key prefix. Avoids re-composing `${API_KEY_PREFIX}${API_KEY_SEPARATOR}`
+ * at every call site. Compile-time `as const` so consumer Zod schemas can
+ * pass it to `.startsWith()` without widening to `string`.
+ */
+declare const API_KEY_PREFIX_WITH_SEPARATOR: "praxium_v1_";
+
 /**
  * Typed error hierarchy for the Praxium SDK.
  *
@@ -849,4 +863,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 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 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

@@ -928,16 +928,19 @@ var STATUS_ERROR_MAP = {
   429: PraxiumRateLimitError
 };
 
-// src/tenant-client.ts
+// src/api-key.constants.ts
 var API_KEY_PREFIX = "praxium_v1";
 var API_KEY_SEPARATOR = "_";
+var API_KEY_PREFIX_WITH_SEPARATOR = `${API_KEY_PREFIX}${API_KEY_SEPARATOR}`;
+
+// src/tenant-client.ts
 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: praxium_v1_{tenantSlug}_{profileSlug}_{timestamp}_{signature}`
+      `API key must start with '${API_KEY_PREFIX}' and contain at least 6 segments. Format: ${API_KEY_PREFIX}${API_KEY_SEPARATOR}{tenantSlug}${API_KEY_SEPARATOR}{profileSlug}${API_KEY_SEPARATOR}{timestamp}${API_KEY_SEPARATOR}{signature}`
     );
   }
   return parts[2];
@@ -1013,6 +1016,9 @@ function localizeText(text, locale) {
   return text[locale] || text["en"] || Object.values(text)[0] || "";
 }
 export {
+  API_KEY_PREFIX,
+  API_KEY_PREFIX_WITH_SEPARATOR,
+  API_KEY_SEPARATOR,
   PraxiumAuthError,
   PraxiumError,
   PraxiumForbiddenError,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@praxium/sdk",
-  "version": "0.4.83",
+  "version": "0.4.87",
   "description": "Official TypeScript SDK for the Praxium platform API",
   "type": "module",
   "exports": {
@@ -19,14 +19,18 @@
   "scripts": {
     "generate": "openapi-ts",
     "build": "tsup",
+    "lint": "eslint src/ tests/",
     "typecheck": "tsc --noEmit && tsc --noEmit -p tsconfig.test.json",
     "test": "vitest run",
     "test:watch": "vitest"
   },
   "devDependencies": {
+    "@eslint/js": "^9.0.0",
     "@hey-api/openapi-ts": "^0.92.4",
+    "eslint": "^9.0.0",
     "tsup": "^8.0.0",
     "typescript": "^5.7.0",
+    "typescript-eslint": "^8.0.0",
     "vitest": "^4.0.18"
   },
   "peerDependencies": {