@bagdock/types

  ----++                                ----++                    ---+++     
  ---+++                                ---++                     ---++      
 ----+---     -----     ---------  --------++ ------     -----   ----++----- 
 ---------+ --------++----------++--------+++--------+ --------++---++---++++
 ---+++---++ ++++---++---+++---++---+++---++---+++---++---++---++------++++  
----++ ---++--------++---++----++---++ ---++---++ ---+---++     -------++    
----+----+---+++---++---++----++---++----++---++---+++--++ --------+---++   
---------++--------+++--------+++--------++ -------+++ -------++---++----++  
 +++++++++   +++++++++- +++---++   ++++++++    ++++++    ++++++  ++++  ++++  
                     --------+++                                             
                       +++++++                                               

@bagdock/types

Shared TypeScript type definitions for the Bagdock platform — operator, marketplace, loyalty, IoT, auth, and API envelope types with domain-specific subpath exports.

Install

npm install @bagdock/types

yarn add @bagdock/types

pnpm add @bagdock/types

bun add @bagdock/types

Quick start

Import everything from the root, or use subpath exports for tree-shaking:

// Root import — all types
import type { Facility, Contact, Rental } from '@bagdock/types'

// Domain-specific subpath imports
import type { Facility, Unit, Tenancy } from '@bagdock/types/operator'
import type { Rental, CheckoutSession } from '@bagdock/types/marketplace'
import type { LoyaltyMember, Reward } from '@bagdock/types/loyalty'
import type { Device, Alert } from '@bagdock/types/iot'
import type { OAuthClient, TokenResponse } from '@bagdock/types/auth'
import type { PaginatedResponse, WebhookEvent } from '@bagdock/types/api'
import type { HiveEmbedConfig } from '@bagdock/types/hive'
import type { SizeCategory, SizeBucket } from '@bagdock/types/sizes'

Subpath exports

Import path	Domain	Key types
@bagdock/types	All	Everything re-exported
@bagdock/types/operator	Operator	Facility, Contact, Company, Listing, Unit, Tenancy, Invoice, Payment, Subscription, Order
@bagdock/types/marketplace	Marketplace	Rental, MarketplaceListing, CheckoutSession, MarketplaceVendor, SearchParams
@bagdock/types/loyalty	Loyalty	LoyaltyMember, PointsTransaction, Reward, Referral, ReferralLink, EmbedToken
@bagdock/types/iot	IoT	Device, Reading, Alert, AccessEvent
@bagdock/types/hive	Hive	HiveEmbedConfig, HiveEmbedToken, HiveMessage, HiveWidget
@bagdock/types/auth	OAuth/OIDC	OAuthClient, OAuthAccessToken, TokenResponse, DeviceCodeResponse, OIDCDiscovery
@bagdock/types/api	API	ApiResponse, PaginatedResponse, ApiError, WebhookEvent, WebhookEventType
@bagdock/types/sizes	Sizes	SizeCategory, SizeBucket, getSizeBuckets, getSizeCategoryForSqft

License

MIT — see LICENSE