@clevercx/security-master-types

TypeScript type definitions for CleverCX Security Master database entities.

Generated from: PostgreSQL database via kysely-codegen

Note: This package provides types for typing only. If you need to query the database with Prisma, use @clevercx/security-master-prisma instead.

Installation

npm install @clevercx/security-master-types

Usage

import type {
  Security,
  SecurityHistoricalPrice,
  SecurityCalculation,
  SecurityReferenceVersion,
  SecurityMetadataVersion,
  SecuritySettingsVersion,
  SecurityComposition,
  VSecuritiesCurrent,
  SecurityTypeEnum,
} from '@clevercx/security-master-types';

// Example: Type your API responses
async function getSecurity(id: string): Promise<Security> {
  const response = await fetch(`/api/securities/${id}`);
  return response.json();
}

// Example: Type your database queries
function mapRowToSecurity(row: Record<string, unknown>): Security {
  return {
    securityId: row.security_id as number,
    internalId: row.internal_id as string,
    ticker: row.ticker as string | null,
    // ...
  };
}

Available Types

Enums

• SecurityTypeEnum - ETF, ETN, ETC, INDEX, MODEL, MUTUAL_FUND
• VersionChangeTypeEnum - Version change types
• FactsetJobStatusEnum - Job status values

Core Entities

• Security - Core security identity
• DataSource - Data provider definitions

Version Tables

• SecurityReferenceVersion - Vendor reference data
• SecurityMetadataVersion - Internal metadata
• SecuritySettingsVersion - Calculation settings
• SecurityVersion - Composite version snapshot

Data Tables

• SecurityHistoricalPrice - Historical price data
• SecurityReturn - Return data
• SecurityCalculation - Calculated metrics
• SecurityComposition - Portfolio composition

Views

• VSecuritiesCurrent - Denormalized current state
• VSecurityVersionHistory - Version audit history

Related Packages

| Package | Purpose | |---------|---------| | @clevercx/security-master-prisma | Prisma schema for querying the database | | clevercx-security-master-types (PyPI) | Python dataclasses |

License

MIT