@rekey.dev/shared-types

ReliPay is now Rekey. This package was previously published as the equivalent @relipay/* package, which is deprecated. Env vars renamed RELIPAY_* → REKEY_* (as of 2.0.0 the old names are no longer read — set REKEY_*). relipay.dev (the old domain) will redirect to rekey.dev after the domain migration.

The Zod schemas + TypeScript types shared between the Rekey API and its SDKs. Anything serialized over the wire lives here, so there's a single source of truth for every shape.

npm i @rekey.dev/shared-types
# or: pnpm add @rekey.dev/shared-types / yarn add @rekey.dev/shared-types

When you need this

Most consumers don't install this directly — the types you'll use day-to-day are re-exported from @rekey.dev/node, so import { PlanDto, RekeyError } from '@rekey.dev/node' already works.

Reach for @rekey.dev/shared-types when you want the runtime Zod schemas (not just the static types) — e.g. to validate a payload you received out-of-band, or to share validation between your own backend and a worker without pulling in the full server SDK. It has zero deps beyond zod.

Setup

No keys, no client, no env vars. Pure types + schemas — import and use.

import {
  RekeyError,
  PlanDtoSchema,
  type PlanDto,
  type AuthResultDto,
} from '@rekey.dev/shared-types';

// Static type:
function priceLabel(plan: PlanDto): string {
  return `${(plan.amount / 100).toFixed(2)} ${plan.currency}`; // amount is integer cents
}

// Runtime validation (the schema, not just the type):
const plan = PlanDtoSchema.parse(await res.json());

What's inside

Each DTO ships as both a Zod schema (…Schema) and an inferred type. Highlights:

| Area | Types | | --- | --- | | Errors | RekeyError (class), RekeyErrorShape, ApiResponseSchema (the { success, data } | { success, error } envelope) | | Application config | ApplicationDto, AuthConfig, BillingConfig, BillingProvider, AccessConfig | | Auth | SignUpRequest, SignInRequest, AuthResultDto, SignInOutcomeDto, MfaChallengeResultDto, MfaVerifyRequest, ForgotPasswordRequest, ResetPasswordRequest, EndUserDto, ApiKeyDto | | Billing | PlanDto, PlanKindType (SUBSCRIPTION / LICENSE / USAGE / CREDIT), SubscriptionDto, CreateCheckoutRequest, CheckoutResultDto, ProvidersListDto | | Coupons | CouponDto, ValidateCouponRequest, ValidateCouponResultDto | | Credits | CreditBalanceDto, CreditLedgerEntryDto, ConsumeCreditsRequest, ConsumeCreditsResultDto, GrantCreditsRequest | | Organizations | OrganizationDto, OrganizationWithRoleDto, OrganizationMemberDto, OrganizationInvitationDto, OrganizationRole | | Licenses | LicenseDto, LicenseKindType, LicenseVerifyResultDto | | Usage | UsageRecordDto, UsageAggregateDto | | MCP / OAuth | OAuthIntrospectionResponse, OAuthAuthServerMetadata, SecurityEventDto | | Outbound webhooks | WEBHOOK_EVENTS (the full { name, description } registry), KNOWN_WEBHOOK_EVENTS, WebhookEventType, isKnownWebhookEvent, WebhookEventEnvelope(+Schema), WebhookEndpointDto, WebhookDeliveryDto, RetryWebhookDeliveryResultDto | | Tenant / operator | TenantPaymentDto + PaymentStatusType, BillingStatsDto (incl. mrrCurrency / mixedCurrencies), TenantEndUserDto, SecurityEventActorType, query-param interfaces (TenantPaymentsListQuery, TenantEndUsersListQuery, SecurityEventsListQuery), EndUserExportDocument (GDPR/DSAR export) |

Gotchas

• RekeyError is the canonical class. @rekey.dev/node and @rekey.dev/react re-export this same class, so instanceof RekeyError is consistent across packages. It lives in the dependency-free @rekey.dev/shared-types/error entry — import it from there in browser code and you get the class without zod (346 B vs 77 KB in a measured esbuild bundle). The barrel re-exports the identical class object, so either path is safe for instanceof.
• Server-authored enums are open unions. WebhookEventType, SubscriptionStatusType, PlanKindType, CreditReasonType and PaymentStatusType are … | (string & {}), because a deployment one minor version ahead sends values this package predates. The known literals still autocomplete; your switch needs a default. The closed set is exported alongside as KnownWebhookEventType, KnownSubscriptionStatus, KnownPlanKind, KnownCreditReason, KnownPaymentStatus — use those for registries and label maps you own, and isKnownWebhookEvent to narrow at runtime. Filter/query types you send stay closed.
• ApplicationDto.environment is optional. GET /api/v1/me does not return it. Narrow before use.
• Money is integer-only, in the smallest currency unit (cents/paise/sen). PlanDto.amount, CheckoutResultDto.discountAmount, etc. are never floats.
• Coupon amountOff: PERCENT is basis points (1500 = 15%); AMOUNT is the smallest currency unit.
• Discriminated unions: branch on the discriminator before reading fields — SignInOutcomeDto on mfaRequired, LicenseVerifyResultDto on ok.
• WEBHOOK_EVENTS mirrors the API registry exactly (names + order). Use it to render event pickers or autocomplete the events array when registering webhook endpoints; dedupe inbound deliveries on the envelope's eventId.
• Tenant/operator DTOs describe panel-session endpoints. /api/v1/tenant/* authenticates with an operator session JWT (or a scoped rp_op_… PAT on the small /tenant/operator/* surface) — not an Application secret key — so @rekey.dev/node deliberately has no methods for them. The types are here for panel-like consumers and agents.

Links

• Docs: /docs · SDK guide · API reference · agent prompt
• Server SDK that re-exports these: @rekey.dev/node

License

MIT