@bizscout/data-model
v0.2.1
Published
Shared Data Model for BizScout applications
Maintainers
Readme
@bizscout/data-model
Shared TypeScript type definitions for BizScout applications. This package exports only types and enums—no runtime code.
Installation
npm install @bizscout/data-modelUsage
import type { ListingData } from '@bizscout/data-model';
import { SourceType, Currency } from '@bizscout/data-model';
const listing: ListingData = {
listingId: '123',
title: 'Coffee Shop for Sale',
price: { amount: 150000, currency: Currency.USD },
description: 'Well-established coffee shop...',
contactInfos: [],
businessInformation: null,
_metadata: { createdAt: new Date(), updatedAt: new Date() },
};Exports
Main Type
ListingData- Core business listing type
Supporting Types
Address,GeoLocation- Location dataIndustry,SubCategory- Business classificationSource,SourceUrls- Data source informationPerson- Contact informationFinancialField- Financial metricsBusinessInformation,RealEstateInfo,Inventory- Business detailsPrice,MetaData- Common types
Enums
SourceType- Data source typesCurrency- Currency codesPersonType- Contact typesRealEstateType- Property typesInventoryType- Inventory categoriesFacilityType- Facility typesFinancialFieldName- Financial field identifiers
Development
npm run build # Compile TypeScript
npm run dev # Watch mode
npm run format # Format code with Prettier
npm run format:check # Check formattingContributing
This project uses changesets for versioning:
npx changeset add # Create a changeset after making changesLicense
ISC
