@goldenhippo/hippo-shop-types
v1.0.1
Published
Public DTO types for Hippo Shop — the typed contract shared by the commerce API and the browser SDK.
Keywords
Readme
@goldenhippo/hippo-shop-types
The DTO contract for Hippo Shop. Zero runtime dependencies, pure TypeScript types — consumed by both the commerce API's DTO mappers and the SDK's typed client so that producer and consumer share the contract literally, not by convention.
Source: GoldenHippoMedia/hippo-shop · Runtime SDK:
@goldenhippo/hippo-shop-sdk
Installation
npm install --save-dev @goldenhippo/hippo-shop-types
# or
pnpm add -D @goldenhippo/hippo-shop-typesUsage
import type {
HippoShopFunnelDTO,
HippoShopDestinationDTO,
HippoShopProductDTO,
HippoShopErrorDTO,
} from '@goldenhippo/hippo-shop-types';Three DTOs
| DTO | Route | Scenario |
|-----|-------|----------|
| HippoShopFunnelDTO | GET /public/v1/funnel/:slugOrId | Render or link a Golden Hippo funnel. |
| HippoShopDestinationDTO | GET /public/v1/destination/:slugOrId | Resolve an offer to a funnel + price. |
| HippoShopProductDTO | GET /public/v1/product/:slugOrId | Display live pricing/availability. |
See docs/hippo-shop-combined-implementation-plan.md for the full architecture and contract reference.
Versioning
Semver — major = API major. 1.x.x targets /public/v1/*. Minor and patch versions are additive only.
No runtime validation
There are no Zod schemas in this package by design. The SDK trusts what comes back from the gateway; the commerce API has its own internal validation; shape conformance is enforced by integration tests on the producer side. If runtime validation is ever needed, a companion package (@goldenhippo/hippo-shop-types-zod) will provide it.
Provenance
Published with SLSA provenance attestation via npm Trusted Publishers + GitHub Actions OIDC.
License
MIT. See LICENSE.
