@praxium/sdk 0.2.4 → 0.2.9

package/src/index.ts

@@ -1,70 +0,0 @@
-/**
- * @praxium/sdk — TypeScript SDK for Praxium Public Tenant API
- *
- * @example
- * ```ts
- * import { createTenantClient, PraxiumNotFoundError } from '@praxium/sdk'
- *
- * const client = createTenantClient({
- *   baseUrl: process.env.PRAXIUM_PLATFORM_URL!,
- *   apiKey: process.env.PRAXIUM_API_KEY!,
- *   tenantSlug: 'ijfysio',
- *   locale: 'nl',
- * })
- *
- * // Returns data directly — throws PraxiumError on failure
- * const hours = await client.getOpeningHours()
- * const team = await client.getTeamMembers()
- * ```
- */
-
-// ─── Client Factory ───
-export { createTenantClient } from './tenant-client'
-export type { TenantClient, TenantClientConfig } from './tenant-client'
-
-// ─── Error Hierarchy ───
-export {
-  PraxiumError,
-  PraxiumAuthError,
-  PraxiumForbiddenError,
-  PraxiumNotFoundError,
-  PraxiumRateLimitError,
-  PraxiumValidationError,
-} from './errors'
-export type { ValidationDetail } from './errors'
-
-// ─── Domain Types (re-exported from generated) ───
-export type {
-  // Domain models
-  OpeningHours,
-  PublicDaySchedule,
-  ContactDetails,
-  ContactFormResult,
-  Location,
-  BusinessName,
-  SocialLinks,
-  TeamMembers,
-  PublicTeamMember,
-  LocalizedSpecialization,
-  FaqContent,
-  FaqGroup,
-  FaqCategory,
-  FaqItem,
-  PricingVariants,
-  PricingVariant,
-  InsuranceList,
-  InsuranceInfo,
-  FeatureList,
-  FeatureItem,
-  PaymentMethodList,
-  PaymentMethod,
-  PolicyList,
-  PolicyInfo,
-  BookableServices,
-  BookableService,
-  BookableVariantInfo,
-  ServiceCategoryInfo,
-  BilingualText,
-  // Error type
-  ApiError,
-} from './generated/types.gen'

package/src/revalidation.ts

@@ -1,105 +0,0 @@
-/**
- * ISR Revalidation Handler for Tenant Websites
- *
- * When admin updates data in the platform, a webhook triggers
- * revalidation on the tenant's public website. This handler
- * validates the secret and calls Next.js revalidatePath().
- *
- * Usage in tenant website's `app/api/revalidate/route.ts`:
- *
- * ```ts
- * import { createRevalidationHandler } from '@praxium/sdk/revalidation'
- *
- * export const POST = createRevalidationHandler({
- *   secret: process.env.PRAXIUM_REVALIDATION_SECRET!,
- * })
- * ```
- */
-
-interface RevalidationConfig {
-  /** Shared secret for webhook authentication */
-  secret: string
-}
-
-interface RevalidationBody {
-  /** Webhook authentication secret */
-  secret: string
-  /** Paths to revalidate (defaults to ['/'] if omitted) */
-  paths?: string[]
-}
-
-/**
- * Timing-safe string comparison to prevent timing side-channel attacks.
- *
- * Uses XOR-based constant-time comparison with TextEncoder (universally
- * available in all JS environments: Node.js, edge runtimes, browsers).
- * This avoids Node.js-specific APIs (Buffer, crypto.timingSafeEqual) to
- * keep the SDK platform-agnostic.
- *
- * The XOR approach is a well-established cryptographic pattern:
- * - Encodes both strings as UTF-8 byte arrays
- * - XORs every byte pair, accumulating mismatches via bitwise OR
- * - Only checks the accumulated result AFTER the full loop
- * - Prevents attackers from inferring secret content by measuring response times
- *
- * Note: Length difference is detected early (unavoidable information leak),
- * but content comparison is always constant-time.
- */
-function isSecretValid(provided: string, expected: string): boolean {
-  const encoder = new TextEncoder()
-  const a = encoder.encode(provided)
-  const b = encoder.encode(expected)
-
-  if (a.length !== b.length) {
-    return false
-  }
-
-  let mismatch = 0
-  for (let i = 0; i < a.length; i++) {
-    mismatch |= a[i] ^ b[i]
-  }
-
-  return mismatch === 0
-}
-
-/**
- * Creates a Next.js route handler that revalidates ISR pages
- * when triggered by the Praxium platform webhook.
- */
-export function createRevalidationHandler(config: RevalidationConfig) {
-  return async (request: Request): Promise<Response> => {
-    let body: RevalidationBody
-
-    try {
-      body = await request.json()
-    } catch {
-      return Response.json({ error: 'Invalid JSON body' }, { status: 400 })
-    }
-
-    if (!isSecretValid(body.secret, config.secret)) {
-      return Response.json(
-        { error: 'Invalid revalidation secret' },
-        { status: 401 }
-      )
-    }
-
-    const paths = body.paths ?? ['/']
-
-    // Dynamic import to avoid bundling next/cache in non-Next.js environments.
-    // Type declarations for next/cache are provided by src/types/next-cache.d.ts
-    // so the DTS generator can emit correct types without next being installed.
-    try {
-      const { revalidatePath } = await import('next/cache')
-      for (const path of paths) {
-        revalidatePath(path)
-      }
-    } catch {
-      return Response.json(
-        { error: 'Revalidation failed — next/cache not available' },
-        { status: 500 }
-      )
-    }
-
-    return Response.json({ revalidated: true, paths })
-  }
-}

package/src/tenant-client.ts

@@ -1,180 +0,0 @@
-/**
- * Praxium Tenant Client
- *
- * High-level wrapper around the auto-generated SDK that binds the
- * tenant slug and API key, giving consumers a clean throw-on-error API:
- *
- * ```ts
- * import { createTenantClient, PraxiumNotFoundError } from '@praxium/sdk'
- *
- * const client = createTenantClient({
- *   baseUrl: 'https://platform.praxium.nl',
- *   apiKey: process.env.PRAXIUM_API_KEY!,
- *   tenantSlug: 'ijfysio',
- * })
- *
- * // Returns data directly — throws PraxiumError on failure
- * const hours = await client.getOpeningHours()
- * ```
- */
-import { createClient, createConfig } from './generated/client'
-import type {
-  ClientOptions,
-  ApiError,
-  SubmitContactFormData,
-  OpeningHours,
-  ContactDetails,
-  ContactFormResult,
-  Location,
-  BusinessName,
-  SocialLinks,
-  TeamMembers,
-  FaqContent,
-  PricingVariants,
-  InsuranceList,
-  FeatureList,
-  PaymentMethodList,
-  PolicyList,
-  BookableServices,
-} from './generated/types.gen'
-import * as sdk from './generated/sdk.gen'
-import { PraxiumError, STATUS_ERROR_MAP } from './errors'
-
-export interface TenantClientConfig {
-  /** Platform base URL (e.g., 'https://platform.praxium.nl') */
-  baseUrl: string
-  /** HMAC-signed API key (format: hmac_v1_{slug}_{timestamp}_{signature}) */
-  apiKey: string
-  /** Tenant identifier slug (must match the slug in the API key) */
-  tenantSlug: string
-  /** Accept-Language header for locale-aware responses (e.g., 'nl', 'en') */
-  locale: string
-}
-
-// ─── Unwrap Helper ───────────────────────────────────────────────────
-
-/**
- * The auto-generated SDK returns `{ data, error, request, response }`.
- *
- * On success, `data` is the parsed JSON body which the API wraps as
- * `{ data: <payload> }`. The response-type mapping gives us
- * `{ data: SomeResponse }` for `data`.
- *
- * On error, `error` is the parsed `ApiError` JSON body.
- *
- * `unwrapOrThrow` extracts the inner payload on success, or throws a
- * typed `PraxiumError` subclass mapped from the HTTP status code.
- */
-function unwrapOrThrow<TPayload>(result: {
-  data?: { data: TPayload } | undefined
-  error?: ApiError | undefined
-  response: Response
-}): TPayload {
-  // Success path — return the inner data payload
-  if (result.data !== undefined && result.error === undefined) {
-    return result.data.data
-  }
-
-  // If both data and error are undefined, the generated client encountered
-  // a network-level failure; fall through to the error path below.
-
-  // Error path — map HTTP status to typed error
-  const status = result.response?.status ?? 500
-  const apiError = result.error as ApiError | undefined
-
-  const errorCode = apiError?.errorCode ?? 'UNKNOWN_ERROR'
-  const message = apiError?.message ?? `HTTP ${status} error`
-  const details = apiError?.details
-
-  const ErrorClass = STATUS_ERROR_MAP[status]
-
-  if (ErrorClass) {
-    throw new ErrorClass(errorCode, message, details)
-  }
-
-  // Fallback for unmapped status codes
-  throw new PraxiumError(status, errorCode, message, details)
-}
-
-// ─── Client Factory ──────────────────────────────────────────────────
-
-export function createTenantClient(config: TenantClientConfig) {
-  const clientInstance = createClient(
-    createConfig<ClientOptions>({
-      baseUrl: config.baseUrl as ClientOptions['baseUrl'],
-      auth: config.apiKey,
-    })
-  )
-
-  // Set Accept-Language header on all requests for locale-aware responses
-  clientInstance.interceptors.request.use((request) => {
-    request.headers.set('Accept-Language', config.locale)
-    return request
-  })
-
-  const path = { tenantSlug: config.tenantSlug }
-
-  return {
-    // ─── Layout Endpoints ───
-    getOpeningHours: (): Promise<OpeningHours> =>
-      sdk.getOpeningHours({ client: clientInstance, path }).then(unwrapOrThrow),
-
-    getContactDetails: (): Promise<ContactDetails> =>
-      sdk
-        .getContactDetails({ client: clientInstance, path })
-        .then(unwrapOrThrow),
-
-    getLocation: (): Promise<Location> =>
-      sdk.getLocation({ client: clientInstance, path }).then(unwrapOrThrow),
-
-    getBusinessName: (): Promise<BusinessName> =>
-      sdk.getBusinessName({ client: clientInstance, path }).then(unwrapOrThrow),
-
-    getSocialLinks: (): Promise<SocialLinks> =>
-      sdk.getSocialLinks({ client: clientInstance, path }).then(unwrapOrThrow),
-
-    // ─── Content Endpoints ───
-    getTeamMembers: (): Promise<TeamMembers> =>
-      sdk.getTeamMembers({ client: clientInstance, path }).then(unwrapOrThrow),
-
-    getFaq: (): Promise<FaqContent> =>
-      sdk.getFaq({ client: clientInstance, path }).then(unwrapOrThrow),
-
-    getServiceVariants: (): Promise<PricingVariants> =>
-      sdk
-        .getServiceVariants({ client: clientInstance, path })
-        .then(unwrapOrThrow),
-
-    getInsuranceInfo: (): Promise<InsuranceList> =>
-      sdk
-        .getInsuranceInfo({ client: clientInstance, path })
-        .then(unwrapOrThrow),
-
-    getFeatures: (): Promise<FeatureList> =>
-      sdk.getFeatures({ client: clientInstance, path }).then(unwrapOrThrow),
-
-    getPaymentMethods: (): Promise<PaymentMethodList> =>
-      sdk
-        .getPaymentMethods({ client: clientInstance, path })
-        .then(unwrapOrThrow),
-
-    getPolicyInfo: (): Promise<PolicyList> =>
-      sdk.getPolicyInfo({ client: clientInstance, path }).then(unwrapOrThrow),
-
-    getBookableServices: (): Promise<BookableServices> =>
-      sdk
-        .getBookableServices({ client: clientInstance, path })
-        .then(unwrapOrThrow),
-
-    // ─── Contact Form ───
-    submitContactForm: (
-      body: SubmitContactFormData['body']
-    ): Promise<ContactFormResult> =>
-      sdk
-        .submitContactForm({ client: clientInstance, path, body })
-        .then(unwrapOrThrow),
-  }
-}
-
-/** Return type of createTenantClient for type inference */
-export type TenantClient = ReturnType<typeof createTenantClient>

package/src/types/next-cache.d.ts

@@ -1,24 +0,0 @@
-/**
- * Type declarations for next/cache — optional peer dependency.
- *
- * next is declared as an optional peerDependency and is NOT installed
- * during SDK CI builds. This stub provides type information for the
- * dynamic import in revalidation.ts so TypeScript's DTS generator
- * can emit correct declarations without requiring next to be installed.
- *
- * Only the functions actually used by the SDK are declared here.
- * Consumers install next themselves (it's a peer dependency).
- */
-declare module 'next/cache' {
-  /**
-   * Revalidates data associated with a specific path.
-   * @see https://nextjs.org/docs/app/api-reference/functions/revalidatePath
-   */
-  export function revalidatePath(path: string, type?: 'page' | 'layout'): void
-
-  /**
-   * Revalidates data associated with a cache tag.
-   * @see https://nextjs.org/docs/app/api-reference/functions/revalidateTag
-   */
-  export function revalidateTag(tag: string): void
-}