API Reference

Every public export of the @simpleapps-com/augur-* packages, read from each package's built type declarations, with the first line of its JSDoc. Each package has its own guide in this section; this page is the complete list.

Generated from the packages' builds by pnpm -C repo/sites/augur-build generate. Do not edit by hand.

@simpleapps-com/augur-core

Universal foundation for Augur packages — proxy infrastructure, cache keys, method classification, shared types

`@simpleapps-com/augur-core`

Values

Export	Kind	Description
`buildCacheKey`	function	Builds a deterministic cache key for Redis/CDN caching.
`buildQueryKey`	function	Builds a deterministic query key from a method path and arguments.
`createActionsProxy`	function	Creates a proxy that wraps every SDK method as a direct async action.
`createDeepProxy`	function	Creates a deep proxy that intercepts property access to build a method path, then calls the handler when the proxy is invoked as a function.
`createFetchQueryAction`	function	Creates a QueryActionFn backed by fetch() to an API endpoint.
`createKeysOnlyProxy`	function	Creates a keys-only proxy for sites without a client-side SDK instance.
`createOptionsProxy`	function	Creates a proxy that returns TanStack Query options for every SDK method.
`createQueryActionProxy`	function	Creates a proxy backed by a query action function instead of a direct SDK instance.
`DEFAULT_CACHE_TIERS`	const	Default cache tier values.
`defineSite`	function	Identity helper that provides type-checking and IDE autocomplete for site configuration objects.
`fnv1a`	function	FNV-1a 32-bit hash. Fast non-cryptographic hash for cache keys. Returns an 8-character zero-padded hex string.
`getCacheTier`	function	Resolves the cache tier for a given SDK method path.
`isNoCachePath`	function	Returns true if the given SDK method path matches a no-cache namespace.
`isReadMethod`	function	Returns true if the leaf method name represents a read (GET) operation.
`isWriteMethod`	function	Returns true if the leaf method name represents a write (POST/PUT/DELETE) operation.
`NO_CACHE_PATHS`	const	Paths that should not be cached at any layer.
`resolveGcTime`	function	Returns the React Query `gcTime` to use for a query built in this runtime. On the server returns `Infinity`, which query-core treats as "schedule no GC timer", so a per-request QueryClient is freed when the request ends. A finite value would start a timer that pins the whole request cache. In the browser returns `clientGcTime` unchanged.
`resolveMethod`	function	Walk an object by path array to find the leaf function.
`stableArgs`	function	Normalize arguments for deterministic cache/query keys. Filters out undefined values from argument objects.
`stableStringify`	function	JSON.stringify with sorted object keys for deterministic cache keys. Ensures { a: 1, b: 2 } and { b: 2, a: 1 } produce the same string.
`stripEdgeCacheForNoCachePaths`	function	Strips the `edgeCache` property from every object arg when the method path is in `NO_CACHE_PATHS`. Defense in depth against CDN edge caching of identity-bound responses.
`unwrapBaseResponse`	function	Unwrap SDK BaseResponse if the result matches the standard shape. The SDK wraps all responses in `{ data: T, status: number, message: string }`. Every query proxy MUST resolve to the same shape for the same query key, so the direct-SDK options proxy (`createOptionsProxy`) and augur-server's `queryAction` both apply this, and `DeepQueryOptions` types results as `T`.

Types

ActionResult, ActionsProxyConfig, ApiResult, AugurAnalyticsConfig, AugurAuthContext, AugurSiteConfig, AugurSiteDefaults, AugurSiteFormatting, AugurSiteItemsConfig, AugurSiteSearchConfig, CacheConfig, CacheProvider, CacheTierConfig, CacheTierDefaults, DeepActions, DeepQueryOptions, EdgeCacheValue, InfiniteScrollPage, IsReadMethod, ListResult, OptionsProxyConfig, ProxyMutationOptions, ProxyQueryOptions, QueryActionFn, ResolvedCacheTier, WrapCallContext

`@simpleapps-com/augur-core/testing`

Values

Export	Kind	Description
`createMockClient`	value

Types

DeepMockClient, MockClientResult, MockFn

@simpleapps-com/augur-utils

Shared types, cache configuration, and utility functions for Augur ecommerce sites

`@simpleapps-com/augur-utils`

Values

Export	Kind	Description
`BillingAddressInvoiceSchema`	const	Valibot schema for billing address with required PO number (invoice payments).
`BillingAddressSchema`	const	Valibot schema for billing address validation. Less strict than shipping: allows PO Box, no email/phone required.
`BLUR_DATA_URL`	const	1x1 transparent PNG for Next.js `<Image blurDataURL={...}>` placeholders.
`buildCheckoutPayload`	function	Builds the oe_hdr + oe_line payload required by the commerce checkout API from cart data.
`buildImageLoader`	function	Returns a loader function compatible with Next.js `<Image loader={...}>`.
`buildTrackingData`	function	Build a GA4 begin_checkout ecommerce payload from cart lines, item details, and prices.
`CACHE_CONFIG`	const	Centralized cache configuration for React Query (TanStack Query)
`categorySortBy`	function	serializeCategoryFilters' sortBy: the prefix applied only when both are non-empty.
`cleanMoney`	function	Remove JS float noise from a money product or sum.
`cn`	function	Merge Tailwind classes without conflicts. Web only (tailwind-merge is meaningless in RN).
`CONTIGUOUS_STATES`	const	Lower 48 contiguous states.
`createImageConfig`	function	Creates a frozen ImageConfig object.
`derivePrice`	function	Pure price derivation — usable in hooks AND server components.
`formatPrice`	function	Locale-aware currency formatting. Defaults to USD -- consumers can override locale and currency.
`generateBreadcrumbJsonLd`	function	Generates a Schema.org BreadcrumbList JSON-LD object from an array of breadcrumb items.
`generateProductJsonLd`	function	Generates a Schema.org Product JSON-LD string from an inventory document. Returns null if the item is suppressed, unnamed, or has no price.
`getBusinessDay`	function	Get the Nth business day from today (skipping weekends).
`getDefaultImageUrl`	function	Returns the default/placeholder image URL. Per-call `options.defaultImage` overrides `config.defaultImage`.
`getImageSrcSet`	function	Generates a `srcset` string for responsive images.
`getImageUrl`	function	Builds a full agr.media URL for the given image path and transforms.
`getPaymentStatus`	function	Returns "Paid", "Partially Paid", or "Unpaid" based on invoice payment flags and amounts.
`getSchemaAvailability`	function	Maps resolved stock to a Schema.org availability URL.
`getShippingLeadDate`	function	Get shipping lead date estimate based on days string (the table is `shippingLeadOf`).
`hasPriceBreaks`	function	Type guard: true when `libraryPriceData` is the price-page shape with quantity `breaks`.
`isAddressDifferent`	function	Compares a user-entered address with a SmartyStreets-validated address. Returns true if any field differs (case-insensitive for address/city, exact match for state abbreviation and zip code).
`normalizePath`	function	Normalizes an image path by: 1. Returning it as-is if it starts with `http` (external URL). 2. Stripping configured prefixes (defaults: `/images`, `images`). 3. Prepending `defaultPath` for bare filenames (no `/`). 4. Stripping leading slashes.
`paginateOffset`	function	Returns a copy of filters with offset adjusted for the given page.
`pushTrackingData`	function	Push ecommerce tracking data to window.dataLayer using the GA4 clear-then-push pattern.
`resolveStock`	function	Pure stock resolution -- usable in hooks AND server components.
`roundHalfAway`	function	Round half away from zero to `decimals` places.
`sanitizeHtmlImages`	function	Rewrites `<img src="...">` attributes in an HTML string to use agr.media URLs. Useful for CMS/Joomla content that contains raw image references.
`serializeCategoryFilters`	function	Converts TItemsFilters to the SDK params shape for category item endpoints.
`serializeSearchParams`	function	Converts TItemsFilters to the SDK params shape for search endpoints.
`serializeTransforms`	function	Serializes transform options into the CDN path segment. Example: `{ width: 400, format: "webp" }` → `"w_400,f_webp"`
`ShippingAddressSchema`	const	Valibot schema for shipping address validation. Enforces no PO Box, requires street number, formats phone number.
`trackAddToCart`	function	Track add_to_cart event to Google Analytics dataLayer.
`trackViewItem`	function	Track view_item event to Google Analytics dataLayer.
`transformShipToAddress`	function	Normalizes a raw ship-to address object (camelCase or snake_case, physical or mailing) into a consistent ShipToAddress shape.
`unwrap`	function	Extracts the data from a `SafeActionResult`, throwing on error.
`unwrapOr`	function	Extracts the data from a `SafeActionResult`, returning `null` on error.
`US_STATES`	const	All US states and territories — backward-compatible {code, name} shape.
`US_STATES_FULL`	const	All US states and territories — full data from states-us.
`US_TERRITORIES`	const	US territories (PR, GU, VI, AS, MP).
`VALIDATION_PATTERNS`	const	Common regex patterns used for form validation across augur-hosted sites.

Types

AddToCartEventParams, BillingAddress, BreadcrumbJsonLdItem, BuildTrackingDataInput, CacheTier, CategoryFilterOptions, CheckoutInput, CheckoutPayment, CustomerDocument, DerivedPrice, DerivePriceInput, ImageConfig, ImageTransforms, ImageUrlOptions, MenuItem, OeHdr, OeLine, OrderHeader, OrderLine, OrderNote, OrderPayment, PaymentStatus, PaymentStatusInvoice, ProductJsonLdAggregateRating, ProductJsonLdOptions, ProductJsonLdSeller, ResolvedStock, ResolveStockInput, SafeActionResult, SchemaAvailability, SearchParamOptions, ShippingAddress, ShipToAddress, TAccountQuery, TApiResponse, TAttribute, TAttributeValue, TBillingUpdate, TCardInfo, TCartHdrUid, TCartLine, TCartLookUp, TCategory, TCategoryChild, TCategoryItemsResult, TCheckoutResult, TInventorySupplier, TInvMast, TInvMastDoc, TItemAccessory, TItemAttribute, TItemAttributes, TItemCategory, TItemDetails, TItemRelatedProduct, TItemsFilters, TItemUom, TJoomlaContent, TJoomlaContentFilters, TLibraryMultiplierData, TLibraryPriceBreak, TLibraryPriceData, TLtlRatesResponse, TLtlShipmentData, TMenu, TMenuFilters, TMetaTags, TOrderCartLine, TPasswordVerification, TPaymentValidation, TPriceData, TProductCategory, TProductItem, TProductStockData, TProfileValues, TrackingData, TrackingItem, TRelatedProduct, TSearchSuggestion, TSearchSuggestionsResponse, TShippingMethod, TSmartyStreets, TStock, TStockData, TSurcharge, TTax, TTaxItem, TTransactionSetup, TUserProfile, TWebDesc, UserAddress, USState, USStateCode, ViewItemEventParams

`@simpleapps-com/augur-utils/web`

Values

Export	Kind	Description
`cn`	function	Merge Tailwind classes without conflicts. Web only (tailwind-merge is meaningless in RN).

@simpleapps-com/augur-hooks

Cross-platform React Query hooks and Zustand stores for Augur ecommerce sites

`@simpleapps-com/augur-hooks`

Values

Export	Kind	Description
`AugurHooksProvider`	function	Provides the augur-api SDK instance, proxy options, and auth to all hooks.
`clearCheckoutPersistence`	function	Clears all checkout persistence keys from sessionStorage.
`clearFromSession`	function	Removes a checkout persistence key from sessionStorage.
`determineOrderReadiness`	function	Pure function that determines if an order is ready to submit.
`executeBatchQuery`	function	Generic batch query executor.
`getRegisteredQueryAction`	function	Returns the registered query action, or null if none registered.
`loadFromSession`	function	Loads a value from sessionStorage, checking TTL and optionally validating.
`registerQueryAction`	function	Register a query action function (called by augur-server/hooks.ts on import).
`saveToSession`	function	Saves a value to sessionStorage with a timestamp for TTL expiration.
`useAugurApi`	function	Returns the augur-api SDK instance from context. Throws if called outside of `<AugurHooksProvider>` or when no api is provided.
`useAugurApiOptional`	function	Returns the augur-api SDK instance from context, or null if not provided. Used internally by hooks that need the SDK for fallback queries.
`useAugurAuth`	function	Returns the provider-level auth context, if any. Used internally by hooks to fall back to provider auth when auth fields are not passed directly as hook parameters.
`useAugurCache`	function	Returns the provider-level cache configuration, if any. Used internally by hooks to enable edge/Redis caching.
`useAugurOptions`	function	Returns the deep proxy for creating TanStack Query options.
`useAugurPersistence`	function	Returns a fully configured `persistOptions` object for use with `PersistQueryClientProvider` from `@tanstack/react-query-persist-client`.
`useAugurSite`	function	Returns the site configuration from the nearest `AugurHooksProvider`. Returns `undefined` when no `site` prop is provided.
`useCartActions`	function	Optimistic cart actions hook with automatic rollback on failure.
`useCartHdrUid`	const	Select the current cart header UID.
`useCartInitialization`	function	Initialize cart state from session (authenticated) or cookie (guest). Call once in the root layout.
`useCartLineCount`	const	Select the number of distinct line items in the cart.
`useCartLines`	const	Select the current cart line items array.
`useCartPricing`	function	Centralized hook for cart/checkout pricing.
`useCartQuantityTotal`	const	Select the total quantity summed across all cart lines.
`useCartStore`	const	Zustand store for cart state. Prefer the individual selector hooks below for optimal re-renders.
`useCheckoutPersistence`	function	Hook that persists checkout state fields to sessionStorage and restores on mount.
`useClearCart`	const	Get the `clearCart` action (stable reference).
`useDebounce`	function	Debounces a rapidly-changing value. Returns the latest value only after `delay` ms of inactivity.
`useFormatPrice`	function	Hook that returns a price formatter. Reads defaults from site config when params are omitted.
`useItemFiltersStore`	const	Zustand store for item list filters, sorting, and pagination state.
`useModalLifecycle`	function	Shared modal lifecycle hook -- scroll lock, Escape key, client-side hydration gate.
`useOrderReadiness`	function	Debounced order readiness hook.
`usePaginationPrefetch`	const	Prefetch adjacent pages on hover for instant pagination. Accepts a generic queryFn so it works with any paginated resource.
`usePaymentFlow`	function	Manages the full Element/Unified payment lifecycle: transactionSetup -> cardInfo -> validatePayment -> accountQuery -> billingUpdate
`useSetCartHdrUid`	const	Get the `setCartHdrUid` action (stable reference).
`useSetCartLines`	const	Get the `setCartLines` action (stable reference). Also recomputes totals.
`useStock`	function	Fetches full TStock data and resolves it into a normalized stock object.

Types

AugurApiClient, AugurAuthContext, AugurSiteConfig, AugurSiteDefaults, AugurSiteFormatting, BatchQueryConfig, CacheConfig, CacheProvider, CacheTierConfig, CartActionCallbacks, CartInitCallbacks, CartPriceData, CartPricingResult, CartSessionInfo, CheckoutPersistField, DeepQueryOptions, DerivedPrice, DerivePriceInput, EdgeCacheValue, FormatPriceCallOptions, GetItemCategoryApiOptions, InfiniteScrollPage, OrderReadinessParams, PageData, PaymentBillingAddress, PaymentFlowCallbacks, PersistenceConfig, ProxyMutationOptions, ProxyQueryOptions, ResolvedStock, ResolveStockInput, SearchSuggestion, SearchSuggestionsResponse, UseFormatPriceOptions, UseStockOptions

`@simpleapps-com/augur-hooks/server`

Values

Export	Kind	Description
`createAugurOptions`	function	Creates server-side query options proxy for prefetching.
`executeBatchQuery`	function	Generic batch query executor.
`getQueryClient`	const	Returns a per-request singleton QueryClient for React Server Components.

Types

AugurApiClient, AugurAuthContext, BatchQueryConfig, CacheConfig, InfiniteScrollPage, PageData

`@simpleapps-com/augur-hooks/web`

Values

Export	Kind	Description
`MobileProvider`	function	Optional provider that tracks hydration state. Wrap your app with this if you need to conditionally render mobile-only content after hydration.
`useImageWithFallback`	function	Preloads an agr.media image and shows a fallback while loading.
`useIsHydrated`	function	Returns true only after the client has hydrated. Prevents hydration mismatches with conditional rendering.
`useIsMobile`	function	Returns whether the screen is mobile-sized. Uses `useSyncExternalStore` for proper SSR support.
`useMobileOptimizedIntersection`	const	IntersectionObserver hook with mobile-optimized root margins. Uses larger margins on mobile for more aggressive prefetching/lazy loading.

`@simpleapps-com/augur-hooks/checkout`

Values

Export	Kind	Description
`createCheckoutProvider`	function
`ORDER_CONFIRMATION_KEY`	const	sessionStorage key for persisted order confirmation data.

Types

CheckoutAddress, CheckoutContext, CheckoutContextValue, CheckoutIdentityConfig, CheckoutLifecycleHooks, CheckoutOrderConfig, CheckoutPaymentConfig, CheckoutPaymentModal, CheckoutProviderConfig, CheckoutProviderProps, CheckoutShippingConfig, CheckoutUIConfig, DefaultCheckoutStep, OrderConfirmation, TCartLine

@simpleapps-com/augur-server

Server-side utilities for Augur ecommerce sites (Redis caching, SDK helpers, auth)

`@simpleapps-com/augur-server`

Values

Export	Kind	Description
`batchFetch`	function	Fetches data for multiple params in parallel, returning a Record keyed by `getKey(param)`. Individual failures are silently excluded from the result so one bad item never takes down the entire batch.
`cacheGet`	function	Read a cached value by key. Returns `null` on cache miss, circuit-open, connection failure, or if Redis is unavailable. Never throws.
`cacheSet`	function	Write a value to cache with a TTL. Fire-and-forget semantics: no-ops silently when the circuit is open or Redis is unavailable. Never throws.
`createQueryOptions`	const	Creates useQuery options with consistent key generation. Filters out undefined/null/empty params from the query key.
`createServerQueryClient`	function	Creates a server-side query client optimised for prefetching.
`createSiteActions`	function	Creates a unified site actions object with all service factories.
`createSuspenseQueryOptions`	const	Creates useSuspenseQuery options with consistent key generation. Same as createQueryOptions but without enabledFn (suspense queries cannot be disabled).
`env`	const	Resolved environment: `"development"`, `"staging"`, or `"production"`.
`getCircuitState`	function	Returns the current circuit breaker state.
`getServerQueryClient`	const	Returns a per-request singleton QueryClient for React Server Components.
`getSiteActions`	function	Returns the registered site actions instance.
`isDev`	const	`true` when running locally (localhost / NODE_ENV=development).
`isProduction`	const	`true` when running on the production deployment.
`isRedisConnected`	function	Whether the Redis client is connected and ready to accept commands.
`isStaging`	const	`true` when running on the staging/dev deployment.
`paginateOffset`	function	Wraps a list of items with offset-based pagination metadata.
`registerSiteActions`	function	Stores the site actions instance for use by server action exports. Called automatically by {@link createServerSite}.
`safeAction`	function	Wraps an async function call with error handling, returning a `SafeActionResult<T>` instead of throwing.
`sdkCall`	function	Calls an Augur SDK method, forwarding all arguments with full type safety.
`unwrap`	value
`unwrapOr`	value
`verifyRecaptcha`	function	Server-side Google reCAPTCHA v3 verification. Used by API routes that accept public form submissions.
`withServerCache`	function	Server-side cache wrapper using augur-server's Redis client.

Types

ActionResult, EdgeCacheValue, PaginatedResult, QueryOptionsConfig, SafeActionResult, SiteActions, SiteActionsConfig

`@simpleapps-com/augur-server/auth`

Values

Export	Kind	Description
`createAuthConfig`	function	Creates a NextAuth configuration with Joomla credential provider, session callbacks, and automatic cart initialization.

Types

AugurAuthCallbacks, AugurAuthClient, AugurJWT, AugurSession, AugurUser, CreateAuthConfigOptions

`@simpleapps-com/augur-server/query`

Values

Export	Kind	Description
`createQueryOptions`	const	Creates useQuery options with consistent key generation. Filters out undefined/null/empty params from the query key.
`createSuspenseQueryOptions`	const	Creates useSuspenseQuery options with consistent key generation. Same as createQueryOptions but without enabledFn (suspense queries cannot be disabled).

Types

QueryOptionsConfig

`@simpleapps-com/augur-server/testing`

Values

Export	Kind	Description
`clearSiteActions`	function	Clears the registered site actions. Used in tests only.
`createMockClient`	value
`createMockSiteActions`	function	Creates a fully-mocked SiteActions object for testing.

Types

DeepMockClient, MockClientResult, MockFn, MockSiteActions, MockSiteActionsResult

`@simpleapps-com/augur-server/site`

Values

Export	Kind	Description
`createServerSite`	function	Create a server-side site instance that bundles the SDK client, server actions, and (optional) NextAuth configuration.

Types

ServerSite, ServerSiteAuthConfig, ServerSiteConfig

`@simpleapps-com/augur-server/actions`

Types

ApiResult, ListResult, SafeActionResult

`@simpleapps-com/augur-server/hooks`

Values

Export	Kind	Description
`createServerQueryProxy`	function	Creates a client-side proxy that mirrors the SDK namespace and routes every method call through a server action function.

Types

QueryActionFn

`@simpleapps-com/augur-server/query-action`

Values

Export	Kind	Description
`getSessionCredentials`	function	Resolve session credentials from the Auth.js JWT cookie.
`queryAction`	function	Generic server action that routes any SDK method call through the raw SDK client with optional Redis caching. Used internally by `createServerQueryProxy()` to bridge client-side React Query hooks to server-side API calls.
`resetSessionImports`	function	Reset lazy-loaded imports. Used in tests only. @internal
`resolveMethod`	function	Resolve a dot-separated method path on an object, returning the leaf function.
`unwrapBaseResponse`	value

`@simpleapps-com/augur-server/api`

Values

Export	Kind	Description
`createAugurApiHandler`	function	Creates a Next.js Route Handler that routes method calls through queryAction.

`@simpleapps-com/augur-server/next-auth`

No exports.

@simpleapps-com/augur-web

Shared React UI components for Augur ecommerce sites (Radix + Tailwind)

`@simpleapps-com/augur-web/accordion`

Values

Export	Kind	Description
`Accordion`	component
`AccordionContent`	component
`AccordionItem`	component
`AccordionTrigger`	component

`@simpleapps-com/augur-web/add-to-cart-button`

Values

Export	Kind	Description
`AddToCartButton`	component

Types

AddToCartButtonProps

`@simpleapps-com/augur-web/breadcrumb`

Values

Export	Kind	Description
`Breadcrumb`	component
`BreadcrumbEllipsis`	const
`BreadcrumbItem`	component
`BreadcrumbLink`	component
`BreadcrumbList`	component
`BreadcrumbPage`	component
`BreadcrumbSeparator`	const

`@simpleapps-com/augur-web/breadcrumbs`

Values

Export	Kind	Description
`BreadCrumbs`	component	Breadcrumb navigation with optional JSON-LD structured data.

Types

BreadCrumbsProps

`@simpleapps-com/augur-web/button`

Values

Export	Kind	Description
`Button`	component	Styled button with variant/size props. Supports polymorphism via `asChild`.
`buttonVariants`	const	CVA variants for the Button. Variants: default, destructive, outline, secondary, ghost, link. Sizes: default, sm, lg, icon.

Types

ButtonProps

`@simpleapps-com/augur-web/card`

Values

Export	Kind	Description
`Card`	component
`CardContent`	component
`CardDescription`	component
`CardFooter`	component
`CardHeader`	component
`CardTitle`	component

`@simpleapps-com/augur-web/checkbox`

Values

Export	Kind	Description
`Checkbox`	component

`@simpleapps-com/augur-web/input`

Values

Export	Kind	Description
`Input`	component

Types

InputProps

`@simpleapps-com/augur-web/label`

Values

Export	Kind	Description
`Label`	component

`@simpleapps-com/augur-web/list-view`

Values

Export	Kind	Description
`ListView`	const	Generic list renderer that maps an array through a render function.

`@simpleapps-com/augur-web/pagination`

Values

Export	Kind	Description
`getPageNumbers`	function	Build an array of page numbers and ellipsis markers for pagination UI.
`ListPagination`	const
`Pagination`	const
`PaginationContent`	component
`PaginationEllipsis`	const
`PaginationItem`	component
`PaginationLink`	const
`PaginationNext`	const
`PaginationPrevious`	const

`@simpleapps-com/augur-web/price`

Values

Export	Kind	Description
`createPrice`	function	Factory that creates a `Price` component and a `formatPrice` function pre-configured with site-level currency/locale/precision.

Types

CreatePriceResult, FormatPriceOptions, PriceClassNames, PriceConfig, PriceFormatConfig, PriceProps

`@simpleapps-com/augur-web/price-format`

Values

Export	Kind	Description
`createFormatPrice`	function	Create a pure price-formatting function. Server-safe (no React dependency). Use {@link createPrice} in client components for the full Price component.

Types

FormatPriceOptions, PriceFormatConfig

`@simpleapps-com/augur-web/radio-group`

Values

Export	Kind	Description
`RadioGroup`	component
`RadioGroupItem`	component

`@simpleapps-com/augur-web/resource-tabs`

Values

Export	Kind	Description
`ResourceTabs`	function	Standardized sub-resource tab layout for detail pages.

Types

ResourceTabsProps, TabDef

`@simpleapps-com/augur-web/select`

Values

Export	Kind	Description
`Select`	component
`SelectContent`	component
`SelectGroup`	component
`SelectItem`	component
`SelectLabel`	component
`SelectScrollDownButton`	component
`SelectScrollUpButton`	component
`SelectSeparator`	component
`SelectTrigger`	component
`SelectValue`	component

`@simpleapps-com/augur-web/spinner`

Values

Export	Kind	Description
`Spinner`	const	Animated SVG loading spinner. Sizes: `sm` (12px), `md` (16px), `lg` (24px).

`@simpleapps-com/augur-web/table`

Values

Export	Kind	Description
`Table`	component
`TableBody`	component
`TableCaption`	component
`TableCell`	component
`TableFooter`	component
`TableHead`	component
`TableHeader`	component
`TableRow`	component

`@simpleapps-com/augur-web/tabs`

Values

Export	Kind	Description
`Tabs`	component
`TabsContent`	component
`TabsList`	component
`TabsTrigger`	component

`@simpleapps-com/augur-web/textarea`

Values

Export	Kind	Description
`Textarea`	component

Types

TextareaProps

`@simpleapps-com/augur-web/command`

Values

Export	Kind	Description
`Command`	component
`CommandDialog`	const
`CommandEmpty`	component
`CommandGroup`	component
`CommandInput`	component
`CommandItem`	component
`CommandList`	component
`CommandSeparator`	component
`CommandShortcut`	const

`@simpleapps-com/augur-web/confirm-dialog`

Values

Export	Kind	Description
`ConfirmDialog`	function	Pre-composed confirmation dialog for delete/action confirmations.

Types

ConfirmDialogProps

`@simpleapps-com/augur-web/data-table`

Values

Export	Kind	Description
`DataTable`	function

Export	Kind	Description
`DetailPanel`	function	Read/edit toggle panel for a single record. Renders field values in read mode, and form inputs in edit mode based on field definitions.

Export	Kind	Description
`Dialog`	component
`DialogClose`	component
`DialogContent`	component
`DialogDescription`	component
`DialogFooter`	const
`DialogHeader`	const
`DialogOverlay`	component
`DialogPortal`	component
`DialogTitle`	component
`DialogTrigger`	component

Values

Export	Kind	Description
`DropdownMenu`	component
`DropdownMenuCheckboxItem`	component
`DropdownMenuContent`	component
`DropdownMenuGroup`	component
`DropdownMenuItem`	component
`DropdownMenuLabel`	component
`DropdownMenuPortal`	component
`DropdownMenuRadioGroup`	component
`DropdownMenuRadioItem`	component
`DropdownMenuSeparator`	component
`DropdownMenuShortcut`	const
`DropdownMenuSub`	component
`DropdownMenuSubContent`	component
`DropdownMenuSubTrigger`	component
`DropdownMenuTrigger`	component

Values

Export	Kind	Description
`NavigationMenu`	component
`NavigationMenuContent`	component
`NavigationMenuIndicator`	component
`NavigationMenuItem`	component
`NavigationMenuLink`	component
`NavigationMenuList`	component
`NavigationMenuTrigger`	component
`navigationMenuTriggerStyle`	const
`NavigationMenuViewport`	component

`@simpleapps-com/augur-web/popover`

Values

Export	Kind	Description
`Popover`	component
`PopoverAnchor`	component
`PopoverContent`	component
`PopoverTrigger`	component

`@simpleapps-com/augur-web/separator`

Values

Export	Kind	Description
`Separator`	component

`@simpleapps-com/augur-web/skeleton`

Values

Export	Kind	Description
`Skeleton`	function

`@simpleapps-com/augur-web/form-field`

Values

Export	Kind	Description
`FormField`	component	Base form layout: label + children + optional error message.

Export	Kind	Description
`FormInput`	component	Labeled text input with error display. Composes FormField + Input.

Export	Kind	Description
`FormSelect`	component	Labeled select dropdown with error display. Composes FormField + Select.

Export	Kind	Description
`FormTextarea`	component	Labeled textarea with error display. Composes FormField + Textarea.

Types

FormTextareaProps

Values

Export	Kind	Description
`FinancingWidget`	function	Loads a financing widget script on the pages where it's needed. Renders nothing — this is a side-effect-only leaf component.

Export	Kind	Description
`AnalyticsNoscript`	function
`AnalyticsProvider`	function
`useAnalytics`	function

Export	Kind	Description
`getMDXComponents`	function	Returns a map of HTML element names to styled React components for use with MDX content rendering.

Types

HtmlComponents

Values

Export	Kind	Description
`extractBin`	function	Extract a card BIN from a postMessage payload. Handles multiple formats returned by Element/Unified iframes: - URL-encoded string with Bin= parameter - Object with Bin, bin, CardBIN, or cardBin property - Nested data.Bin structure
`PaymentModal`	function

Export	Kind	Description
`QuantityInput`	component	Numeric input with optional +/- stepper buttons for cart quantities.

Export	Kind	Description
`SessionReplayScript`	function	Loads a session replay script with `lazyOnload` behavior. Renders nothing — this is a side-effect-only leaf component.

Export	Kind	Description
`createStockLabel`	function

Export	Kind	Description
`AugurSiteProvider`	function	Unified site provider that composes AugurHooksProvider with analytics based on the site config.

Export	Kind	Description
`augurPlugin`	const	Augur Tailwind CSS v4 plugin.
`default`	const	Augur Tailwind CSS v4 plugin.

Export	Kind	Description
`default`	const	The ESLint preset for Augur packages and React sites.

Export	Kind	Description
`default`	const	The ESLint preset for Next.js sites: the base rules plus Next's recommended and Core Web Vitals.

`@simpleapps-com/augur-config/prettier`

Values

Export	Kind	Description
`default`	const	The Prettier preset for Augur packages (with Tailwind class sorting).

`@simpleapps-com/augur-config/prettier/next`

Values

Export	Kind	Description
`default`	const	The Prettier preset for Next.js sites: the base options plus sorted, grouped imports.

Export	Kind	Description
`defaultAssertions`	const	Default assertion thresholds for Augur e-commerce sites.
`lighthousePreset`	function	Creates a Lighthouse CI config with Augur e-commerce defaults.

Types

LighthousePresetOptions