@global-torque/domain-types 0.2.2

package/src/investmentTypes.ts

@@ -0,0 +1,204 @@
+import type {
+  IOffer,
+  IOfferFormatted,
+} from './offerTypes.ts';
+import type { VaultPosition } from './vaultTypes.ts';
+
+export const FundingTypes = {
+  ach: 'ach',
+  wire: 'wire',
+  wallet: 'wallet',
+  cryptoWallet: 'crypto_wallet',
+} as const;
+
+export type FundingTypes = typeof FundingTypes[keyof typeof FundingTypes];
+
+export const InvestStepTypes = {
+  amount: 'amount',
+  ownership: 'ownership',
+  signature: 'signature',
+  funding: 'funding',
+  review: 'review',
+} as const;
+
+export type InvestStepTypes = typeof InvestStepTypes[keyof typeof InvestStepTypes];
+
+export const InvestmentStatuses = {
+  confirmed: 'confirmed',
+  legally_confirmed: 'legally_confirmed',
+  closed_successfully: 'closed_successfully',
+  cancelled_after_investment: 'cancelled_after_investment',
+} as const;
+
+export type InvestmentStatuses = typeof InvestmentStatuses[keyof typeof InvestmentStatuses];
+
+export interface IInvestPaymentData {
+  account_type: string;
+  account_number: string;
+  routing_number: string;
+  account_holder_name: string;
+  created_at?: Date;
+  updated_at?: Date;
+  transaction_id: string;
+}
+
+export interface ISignatureData {
+  created_at: string;
+  signature_id: string;
+  entity_id: string;
+  provider: string;
+  ip_address: string;
+  user_browser: string;
+  signed_by_investor: boolean;
+}
+
+export const InvestFundingStatuses = {
+  none: 'none',
+  creation_error: 'creation_error',
+  new: 'new',
+  initialize: 'initialize',
+  in_progress: 'in_progress',
+  received: 'received',
+  settled: 'settled',
+  sent_back_pending: 'sent_back_pending',
+  sent_back_settled: 'sent_back_settled',
+  failed: 'failed',
+  canceled: 'canceled',
+  cancelled: 'cancelled',
+  error: 'error',
+} as const;
+
+export type InvestFundingStatuses = typeof InvestFundingStatuses[keyof typeof InvestFundingStatuses];
+
+export interface IEscrowData {
+  pr_name: string;
+  transaction_id: string;
+  pr_approval_date: string;
+  pr_approval_status: string;
+}
+
+export interface IInvestment {
+  closed_at: Date;
+  id: number;
+  offer: IOffer;
+  profile_id: number;
+  user_id: number;
+  price_per_share: string;
+  number_of_shares: string | null;
+  amount: number;
+  step: InvestStepTypes;
+  status: InvestmentStatuses;
+  created_at: Date;
+  submited_at: Date;
+  funding_type: FundingTypes;
+  funding_status: InvestFundingStatuses;
+  signature_data: ISignatureData;
+  escrow_data: IEscrowData;
+  payment_data: IInvestPaymentData;
+  payment_type: string;
+  escrow_type: string;
+  entity_id: string;
+  transaction_ref: string;
+  notes?: string;
+  deposit_price_source?: 'offer_deck' | 'finalized_nav' | 'chain_forward_nav' | null;
+  deposit_price_usdc_raw?: string | null;
+  deposit_nav_record_id?: number | null;
+  deposit_nav_version?: number | null;
+  deposit_priced_at?: string | null;
+  asset_amount_raw?: string | null;
+  share_amount_raw?: string | null;
+  vault?: VaultPosition['vault'] | null;
+}
+
+export interface IInvestmentFormatted extends IInvestment {
+  offer: IOfferFormatted;
+  amountFormatted: string;
+  amountFormattedZero: string;
+  amountWithSign: string;
+  numberOfSharesFormatted: string;
+  pricePerShareFormatted: string;
+  createdAtFormatted: string;
+  createdAtTime: string;
+  submitedAtFormatted: string;
+  submitedAtTime: string;
+  paymentDataCreatedAtFormatted: string;
+  paymentDataCreatedAtTime: string;
+  paymentDataUpdatedAtFormatted: string;
+  paymentDataUpdatedAtTime: string;
+  fundingStatusFormatted: string;
+  fundingTypeFormatted: string;
+  isFundingTypeWire: boolean;
+  statusFormatted: {
+    text: string;
+    tooltip?: string;
+    color: string;
+  };
+  isActive: boolean;
+  isCompleted: boolean;
+  isCancelled: boolean;
+  isPending: boolean;
+  isFundingClickable: boolean;
+}
+
+export interface IInvestmentsData {
+  meta: {
+    avarange_annual: number;
+    total_distributions: number;
+    total_investments_12_months: number;
+    total_investments: number;
+  };
+  count: number;
+  data: IInvestmentFormatted[];
+}
+
+/** Raw API response for confirmed investments list before formatting. */
+export interface IInvestmentsDataRaw {
+  meta: IInvestmentsData['meta'];
+  count: number;
+  data: IInvestment[];
+}
+
+export interface IInvestUnconfirmed {
+  count: number;
+  data: (IInvestment | IInvestmentFormatted)[];
+}
+
+export interface IInvestConfirm {
+  investment: IInvestmentFormatted;
+  replayed?: boolean;
+}
+
+export interface IInvestFunding {
+  funding_type: FundingTypes;
+  payment_data?: {
+    account_number: string;
+    routing_number: string;
+    account_holder_name: string;
+    account_type: string;
+  };
+}
+
+export const InvestmentDocumentsTypes = {
+  agreement: 'agreement',
+  tax_document: 'tax document',
+  offer_document: 'offer document',
+} as const;
+
+export type InvestmentDocumentsTypes = typeof InvestmentDocumentsTypes[keyof typeof InvestmentDocumentsTypes];
+
+export interface IInvestmentDocuments {
+  id: number;
+  url: string;
+  name: string;
+  filename: string;
+  mime: string;
+  bucket_path: string;
+  updated_at: string;
+  meta_data: {
+    big: string;
+    small: string;
+    medium: string;
+    size: number;
+  };
+  type: InvestmentDocumentsTypes;
+}

package/src/kycTypes.ts

@@ -0,0 +1,44 @@
+export const InvestKycTypes = {
+  none: 'none',
+  new: 'new',
+  pending: 'pending',
+  approved: 'approved',
+  declined: 'declined',
+  in_progress: 'in_progress',
+} as const;
+
+export type InvestKycTypes = typeof InvestKycTypes[keyof typeof InvestKycTypes];
+
+export interface IKycTokenResponse {
+  expiration: string;
+  link_token: string;
+  request_id: string;
+}
+
+export interface IKycIdentity {
+  id: string;
+  status: string;
+  created_at: string;
+  updated_at: string;
+}
+
+export interface IKycData {
+  completed_at: string;
+  created_at: string;
+  status: InvestKycTypes;
+}
+
+export interface IKycProfile {
+  id: number;
+  user_id: number;
+  kyc_status: InvestKycTypes;
+  kyc_data: IKycData[];
+  created_at: string;
+  updated_at: string;
+}
+
+export type KycPlaidLaunchStatus = 'success' | 'exit';
+
+export interface KycPlaidLaunchResult {
+  status: KycPlaidLaunchStatus;
+}

package/src/notificationsTypes.ts

@@ -0,0 +1,95 @@
+import type { AccreditationTypes } from './accreditationTypes.ts';
+import type { InvestKycTypes } from './kycTypes.ts';
+import type { IProfileIndividual } from './profilesTypes.ts';
+
+export interface INotificationToken {
+  address: string;
+  id: number;
+  name: string;
+  offer_id: number;
+  symbol?: string;
+  decimals?: number;
+  standard?: string;
+  chain?: string;
+  balance_type?: 'rwa_asset' | 'tradable_crypto';
+}
+
+export interface INotificationDataFields {
+  kyc_status?: InvestKycTypes;
+  accreditation_status?: AccreditationTypes;
+  funding_status?: string;
+  status?: string;
+  object_id?: number | string;
+  source_file_id?: number | string;
+  address?: string;
+  amount?: string;
+  balance?: number;
+  inc_balance?: number;
+  out_balance?: number;
+  profile?: IProfileIndividual;
+  confirmed_shares?: string;
+  subscribed_shares?: string;
+  type: string;
+  transaction_tx?: string;
+  created_at?: string;
+  updated_at?: string;
+  investment_id?: number | null;
+  offer_id?: number | null;
+  network?: string;
+  chain?: string;
+  balance_type?: 'rwa_asset' | 'tradable_crypto';
+  token?: INotificationToken;
+  operation_effects?: {
+    effect_id?: number | string;
+    chain_account_id?: number | string;
+    effect_kind?: string;
+    effect_index?: number | string;
+  } | null;
+  signature_data?: {
+    signature_id?: number | string;
+    entity_id?: string;
+    provider?: string;
+    created_at?: string;
+    updated_at?: string;
+    [key: string]: unknown;
+  };
+}
+
+interface INotificationData {
+  obj: string;
+  object_id: number;
+  fields: INotificationDataFields;
+}
+
+export interface INotification {
+  id: number;
+  user_id: number;
+  content: string;
+  data: INotificationData;
+  status: string;
+  type: string;
+  created_at: string;
+  updated_at: string;
+}
+
+export interface IFormattedNotification extends INotification {
+  isNotificationInvestment: boolean;
+  isNotificationDocument: boolean;
+  isNotificationSystem: boolean;
+  isNotificationWallet: boolean;
+  isNotificationProfile: boolean;
+  isNotificationUser: boolean;
+  objectId: number;
+  profileId: number;
+  kycDeclined: boolean;
+  accreditationDeclined: boolean;
+  accreditationExpired: boolean;
+  isStart: boolean;
+  isFundsFailed: boolean;
+  tagBackground: string;
+  buttonText: string;
+  tagText: string;
+  isUnread: boolean;
+  buttonTo: string;
+  buttonHref: string;
+}

package/src/offerCardTypes.ts

@@ -0,0 +1,48 @@
+export interface VOfferCardData {
+  id?: number | string;
+  name?: string;
+  slug?: string;
+  seo_description?: string;
+  href?: string;
+  imageMedium?: string;
+  imageSmall?: string;
+  imageBig?: string;
+  imageSrc?: string;
+  imageSrcset?: string;
+  imageSizes?: string;
+  isDefaultImage?: boolean;
+  minInvestmentFormatted?: string;
+  targetRaiseFormatted?: string;
+  pricePerShareFormatted?: string;
+  isOpenEnded?: boolean;
+  securityTypeFormatted?: string;
+  interestRateFormatted?: string;
+  dividendRateFormatted?: string;
+  votingRightsFormatted?: string;
+  isSecurityTypeDebt?: boolean;
+  isSecurityTypeConvertibleDebt?: boolean;
+  isSecurityTypeConvertibleNote?: boolean;
+  isSecurityTypeEquity?: boolean;
+  isSecurityTypePreferredEquity?: boolean;
+  isStatusClosedSuccessfully?: boolean;
+  tagText?: string;
+  tagBackground?: string;
+  showTag?: boolean;
+  actionLabel?: string;
+}
+
+export type VOfferHrefResolver<TOffer extends VOfferCardData = VOfferCardData> = (
+  offer: TOffer
+) => string | undefined;
+
+export function getDefaultOfferHref(offer?: VOfferCardData): string | undefined {
+  if (!offer) {
+    return undefined;
+  }
+
+  if (offer.href) {
+    return offer.href;
+  }
+
+  return offer.slug ? `/${offer.slug}` : undefined;
+}

package/src/offerTypes.ts

@@ -0,0 +1,275 @@
+export const OfferStatuses = {
+  new: 'new',
+  draft: 'draft',
+  legal_review: 'legal_review',
+  legal_accepted: 'legal_accepted',
+  legal_declined: 'legal_declined',
+  published: 'published',
+  legal_closed: 'legal_closed',
+  closed_successfully: 'closed_successfully',
+  closed_unsuccessfully: 'closed_unsuccessfully',
+} as const;
+
+export type OfferStatuses = typeof OfferStatuses[keyof typeof OfferStatuses];
+
+export const PaymentScheduleTypes = {
+  interest_only_monthly: 'Interest-Only Monthly',
+  interest_only_quarterly: 'Interest-Only Quarterly',
+  fully_amortizing_monthly: 'Fully Amortizing Monthly',
+  all_at_maturity: 'All at Maturity',
+  principal_at_maturity: 'Principal at Maturity',
+} as const;
+
+export type PaymentScheduleTypes = typeof PaymentScheduleTypes[keyof typeof PaymentScheduleTypes];
+
+export const VotingRightsTypes = {
+  one_vote_per_share: '1 Vote per Share',
+  no_voting_rights: 'No Voting Rights',
+  other: 'Other',
+} as const;
+
+export type VotingRightsTypes = typeof VotingRightsTypes[keyof typeof VotingRightsTypes];
+
+export const DividendType = {
+  none: 'None',
+  cumulative: 'Cumulative',
+  non_cumulative: 'Non-Cumulative',
+} as const;
+
+export type DividendType = typeof DividendType[keyof typeof DividendType];
+
+export const DividendFrequencyTypes = {
+  annually: 'Annually',
+  quarterly: 'Quarterly',
+  at_discretion_of_board: 'At Discretion of Board',
+} as const;
+
+export type DividendFrequencyTypes = typeof DividendFrequencyTypes[keyof typeof DividendFrequencyTypes];
+
+export const SecurityType = {
+  equity: 'Equity',
+  'preferred-equity': 'Preferred Equity',
+  debt: 'Debt',
+  equity_warrants: 'Equity Warrants',
+  preference_shares: 'Preference Shares',
+  convertible_bonds: 'Convertible Bonds',
+  convertible_debt: 'Convertible Debt',
+  'convertible-note': 'Convertible Note',
+} as const;
+
+export type SecurityType = typeof SecurityType[keyof typeof SecurityType];
+
+export const OfferDocumentsObjectTypes = {
+  company: 'company',
+  investment_agreements: 'investment-agreements',
+  tax: 'tax',
+} as const;
+
+export type OfferDocumentsObjectTypes = typeof OfferDocumentsObjectTypes[keyof typeof OfferDocumentsObjectTypes];
+
+export interface IOfferInfoData {
+  wire_to: string;
+  swift_id: string;
+  custodian: string;
+  account_number: string;
+  routing_number: string;
+  apy: string;
+  distribution_frequency: string;
+  investment_strategy: string;
+  estimated_hold_period: string;
+  video?: string;
+}
+
+export interface ISecurityInfo {
+  voting_rights?: string;
+  liquidation_preference?: string;
+  dividend_type?: string;
+  dividend_rate?: string;
+  dividend_payment_frequency?: string;
+  cn_valuation_cap?: string;
+  cn_discount_rate?: string;
+  cn_interest_rate?: string;
+  cn_maturity_date?: string;
+  interest_rate_apy?: string;
+  debt_payment_schedule?: string;
+  debt_maturity_date?: string;
+  debt_interest_rate?: string;
+  debt_term_length?: string;
+  debt_term_unit?: string;
+  pre_money_valuation?: number;
+}
+
+export interface OfferOnChainSummary {
+  network: string;
+  custody?: {
+    address?: string | null;
+    explorer_url?: string;
+  };
+  asset_token?: {
+    standard: 'ERC-20' | 'ERC-7943' | 'unknown';
+    symbol: string;
+    name: string;
+    address: string | null;
+    decimals?: number;
+    explorer_url?: string;
+  };
+  vault?: {
+    standard: string;
+    address?: string | null;
+    explorer_url?: string;
+    share_decimals?: number;
+    share_symbol?: string;
+  };
+  latest_finalized_nav?: {
+    id: number;
+    version: number;
+    nav_usdc_raw: string;
+    vault_total_supply_raw: string;
+    nav_share_supply_raw: string;
+    valuation_block_number: string;
+    valuation_as_of: string;
+    finalized_at: string;
+  } | null;
+  subscription_availability?: {
+    available: boolean;
+    reason: 'offer_not_published'
+      | 'not_open_ended'
+      | 'unsupported_tokenization_engine'
+      | 'vault_not_deployed'
+      | null;
+  };
+}
+
+export interface IOffer {
+  id: number;
+  name: string;
+  legal_name: string;
+  slug: string;
+  title: string;
+  security_type: string;
+  price_per_share: string;
+  min_investment: string;
+  image_link_id: number;
+  total_shares: string;
+  valuation: number;
+  subscribed_shares: string;
+  confirmed_shares: string;
+  fund_structure?: 'open_ended' | 'closed_ended';
+  status: string;
+  approved_at: string;
+  website: string;
+  state: string;
+  city: string;
+  security_info: ISecurityInfo;
+  close_at: string;
+  seo_title: string;
+  seo_description: string;
+  description?: string;
+  highlights?: string;
+  risk_disclosures?: string;
+  additional_details: string;
+  data?: IOfferInfoData;
+  linkedin?: string;
+  facebook?: string;
+  twitter?: string;
+  github?: string;
+  instagram?: string;
+  telegram?: string;
+  mastodon?: string;
+  reg_type?: string;
+  amount_raised: number;
+  target_raise: number;
+  tokenization_engine?: string;
+  tokenization_model?: string;
+  on_chain_summary?: OfferOnChainSummary;
+}
+
+export interface IOfferData {
+  count: number;
+  data: IOffer[];
+}
+
+export interface IOfferSharesError {
+  number_of_shares: string[];
+}
+
+export interface IOfferComment {
+  created_at: string;
+  comment: string;
+  related?: string;
+  user: {
+    first_name: string;
+    last_name: string;
+  };
+}
+
+export interface IOfferCommentsResponse {
+  count: number;
+  data: IOfferComment[];
+}
+
+export interface IOfferCommentPayload {
+  comment: string;
+  related?: string;
+  offer_id: number;
+}
+
+export interface IOfferFormatted extends IOffer {
+  amountRaisedFormatted: string;
+  targetRaiseFormatted: string;
+  pricePerShareFormatted: string;
+  valuationFormatted: string;
+  preMoneyValuationFormatted: string | number | undefined;
+  securityTypeFormatted: string;
+  securityTypeTooltip: string | undefined;
+  statusFormatted: {
+    text: string;
+    color: string;
+  };
+  approvedAtFormatted: string;
+  closeAtFormatted: string;
+  isDefaultImage: boolean;
+  minInvestment: string;
+  minInvestmentFormatted: string;
+  offerFundedPercent: number;
+  isOpenEnded: boolean;
+  isFullyFunded: boolean;
+  isClosingSoon: boolean;
+  isSharesReached: boolean;
+  imageBig: string;
+  imageSmall: string;
+  imageMedium: string;
+  isNew: boolean;
+  tagText: string;
+  tagBackground: string;
+  showTag: boolean;
+  isStatusNew: boolean;
+  isStatusDraft: boolean;
+  isStatusLegalReview: boolean;
+  isStatusLegalAccepted: boolean;
+  isStatusLegalDeclined: boolean;
+  isStatusPublished: boolean;
+  isStatusLegalClosed: boolean;
+  isStatusClosedSuccessfully: boolean;
+  isStatusClosedUnsuccessfully: boolean;
+  isFundingCompleted: boolean;
+  votingRightsFormatted: string | undefined;
+  liquidationPreferenceFormatted: string | undefined;
+  dividendTypeFormatted: string | undefined;
+  dividendRateFormatted: string | undefined;
+  dividendPaymentFrequencyFormatted: string | undefined;
+  valuationCapFormatted: string | undefined;
+  discountRateFormatted: string | undefined;
+  interestRateFormatted: string | undefined;
+  maturityDateFormatted: string | undefined;
+  interestRateApyFormatted: string | undefined;
+  paymentScheduleFormatted: string | undefined;
+  termLengthFormatted: string | undefined;
+  isSecurityTypeConvertibleDebt: boolean;
+  isSecurityTypeConvertibleNote: boolean;
+  isSecurityTypeDebt: boolean;
+  isSecurityTypeEquity: boolean;
+  isSecurityTypePreferredEquity: boolean;
+  valuationLabel: string;
+  isRegD506cOffer: boolean;
+}

package/src/onboardingTypes.ts

@@ -0,0 +1,55 @@
+import type { ProfileType } from './profileTypes.ts';
+
+export const SIGNUP_PROFILE_TYPES = ['individual', 'entity', 'trust'] as const;
+
+export type SignupProfileType = Extract<
+  ProfileType,
+  (typeof SIGNUP_PROFILE_TYPES)[number]
+>;
+
+export const WALLET_ONBOARDING_PROFILE_TYPES = [
+  'individual',
+  'entity',
+  'trust',
+  'sdira',
+  'solo401k',
+] as const;
+
+export type WalletOnboardingProfileType = Extract<
+  ProfileType,
+  (typeof WALLET_ONBOARDING_PROFILE_TYPES)[number]
+>;
+
+export type DirectSignupIntent = {
+  kind: 'direct-signup';
+  profileType: SignupProfileType;
+  firstName?: string;
+  lastName?: string;
+  email?: string;
+};
+
+export type InvitationSignupIntent = {
+  kind: 'invitation-signup';
+  invitationCode: string;
+  recommendedProfileType: SignupProfileType;
+  selectedProfileType: SignupProfileType;
+  firstName: string;
+  lastName: string;
+  email: string;
+};
+
+export type WalletOnboardingIntent = {
+  profileId: number;
+  expectedProfileType: WalletOnboardingProfileType;
+  nextPath: string;
+};
+
+export type ProfileCreationHandoff = {
+  onboarding: 'signup';
+  profileType: Exclude<SignupProfileType, 'individual'>;
+  nextPath: string;
+  firstName?: string;
+  lastName?: string;
+  email?: string;
+  acceptedProfileId?: number;
+};