Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@gg-world/deals

captaincrouton89585MIT1.41.0TypeScript support: included

Zod schemas and TypeScript types for deal-related data structures

zod, typescript, types, deals

readme

@gg-world/deals

A TypeScript package providing Zod schemas and types for deal-related data structures.

Installation

npm install @gg-world/deals

Dependencies

This package requires the following peer dependencies:

  • mongodb: ^6.3.0
  • zod: ^3.22.4

Make sure to install them alongside this package:

npm install mongodb zod

Usage

import { DealSchema, DealType, CompanyInfoSchema } from "@gg-world/deals";

// Parse and validate data
const dealData = DealSchema.parse(rawData);

// Type inference
const deal: DealType = {
  // Your deal data here
};

// Use individual schemas
const companyData = CompanyInfoSchema.parse(rawCompanyData);

Available Schemas and Types

Enums

  • DealStatusEnum / DealStatus
  • LinkParsingStatusEnum / LinkParsingStatus
  • LinkStatusEnum / LinkStatus
  • LinkTypeEnum / LinkType

Core Schemas

  • CompanyInfoSchema / CompanyInfo
  • FounderInfoSchema / FounderInfo
  • BusinessMetricsSchema / BusinessMetrics
  • FundraisingInfoSchema / FundraisingInfo

Main Schemas

  • DealProfileSchema / DealProfile
  • LinkParsingResultSchema / LinkParsingResult
  • EnrichmentMetadataSchema / EnrichmentMetadata
  • DealFactorSchema / DealFactor
  • DealScoringSchema / DealScoring
  • DealSchema / DealType
  • DealDocument (includes MongoDB ObjectId)

License

MIT