@kp-universe/schema-types

NetServe shared TypeScript enums and generated event interfaces — sourced from the NetServe Schema Registry.

Installation

npm install @kp-universe/[email protected]

Always pin to an exact version. Do not use ^ or ~ — this is a contract package.

Usage

import {
  OrderCreatedEvent,
  BuyerBehaviorRecordedEvent,
  OrderStatus,
  VendorStatus,
  isOrderEvent,
  AnyOrderEvent,
} from '@kp-universe/schema-types'

// Type-check an inbound event
function handleEvent(raw: unknown): void {
  if (isOrderEvent(raw)) {
    const event: AnyOrderEvent = raw
    console.log(event.payload.orderId, event.payload.status)
  }
}

// Construct an outbound event payload
const event: OrderCreatedEvent = {
  eventType: 'order.created.v1',
  version: '1',
  correlationId: 'req-abc-123',
  timestamp: new Date().toISOString(),
  producer: 'platform-api',
  payload: {
    orderId: 'order-xyz',
    buyerId: 'buyer-abc',
    vendorId: 'vendor-def',
    items: [],
    totalKobo: 25000,
    status: OrderStatus.PENDING,
  },
}

Available Exports

Shared Enums

All Prisma enums re-exported as TypeScript const enums:

• OrderStatus — PENDING, CONFIRMED, PREPARING, READY_FOR_PICKUP, OUT_FOR_DELIVERY, COMPLETED, CANCELLED, FAILED, REFUNDED
• VendorStatus — ACTIVE, INACTIVE, SUSPENDED, BANNED
• UserRole — BUYER, VENDOR, ADMIN, SUPER_ADMIN
• ProductStatus — DRAFT, ACTIVE, ARCHIVED
• DeliveryStatus — ASSIGNED, PICKED_UP, IN_TRANSIT, DELIVERED, FAILED
• 40+ additional enums — see dist/shared-enums/index.d.ts

Generated Event Interfaces (134 events across 20 modules)

| Module | Events | |--------|--------| | Buyers | BuyerBehaviorRecordedEvent, BuyerRecapGeneratedEvent, BuyerStreakUpdatedEvent, ... | | Orders | OrderCreatedEvent, OrderStatusUpdatedEvent, OrderCancelledEvent, ... | | Cart | CartUpdatedEvent, CartAbandonedEvent, ... | | Checkout | CheckoutCompletedEvent, CheckoutFailedEvent, ... | | Inventory | InventoryAdjustedEvent, StockReservedEvent, ... | | Intelligence | RecommendationGeneratedEvent, RebuyPredictedEvent, ... | | Logistics | DispatchCreatedEvent, DeliveryCompletedEvent, ... | | Messaging | MessageSentEvent, ConversationCreatedEvent, ... | | QR | QrScannedEvent, ScanCheckoutStartedEvent, ... | | ... | All 134 events |

Type Guards & Union Types

import { isOrderEvent, isBuyerEvent, isAuthEvent, AnyOrderEvent } from '@kp-universe/schema-types'

Version Policy

This package follows the NetServe Schema Registry semver rules:

• MAJOR — breaking change (field removed, type changed, event removed)
• MINOR — additive change (new event, new optional field)
• PATCH — editorial (description updates, constraint relaxation)

Source

Generated from: contracts/events/ in netserve-schema-registry

Do not edit generated files directly — raise a PR in the schema registry instead.