fmp-node-types 0.1.2

package/dist/index.js

@@ -0,0 +1,48 @@
+'use strict';
+
+// src/common.ts
+var Period = /* @__PURE__ */ ((Period2) => {
+  Period2["ANNUAL"] = "annual";
+  Period2["QUARTER"] = "quarter";
+  return Period2;
+})(Period || {});
+var Exchange = /* @__PURE__ */ ((Exchange2) => {
+  Exchange2["NYSE"] = "NYSE";
+  Exchange2["NASDAQ"] = "NASDAQ";
+  Exchange2["AMEX"] = "AMEX";
+  Exchange2["TSX"] = "TSX";
+  Exchange2["LSE"] = "LSE";
+  Exchange2["ASX"] = "ASX";
+  Exchange2["NSE"] = "NSE";
+  Exchange2["BSE"] = "BSE";
+  return Exchange2;
+})(Exchange || {});
+
+// src/insider.ts
+var TransactionType = /* @__PURE__ */ ((TransactionType2) => {
+  TransactionType2["AWARD"] = "A-Award";
+  TransactionType2["CONVERSION"] = "C-Conversion";
+  TransactionType2["RETURN"] = "D-Return";
+  TransactionType2["EXPIRE_SHORT"] = "E-ExpireShort";
+  TransactionType2["IN_KIND"] = "F-InKind";
+  TransactionType2["GIFT"] = "G-Gift";
+  TransactionType2["EXPIRE_LONG"] = "H-ExpireLong";
+  TransactionType2["DISCRETIONARY"] = "I-Discretionary";
+  TransactionType2["OTHER"] = "J-Other";
+  TransactionType2["SMALL"] = "L-Small";
+  TransactionType2["EXEMPT"] = "M-Exempt";
+  TransactionType2["OUT_OF_THE_MONEY"] = "O-OutOfTheMoney";
+  TransactionType2["PURCHASE"] = "P-Purchase";
+  TransactionType2["SALE"] = "S-Sale";
+  TransactionType2["TENDER"] = "U-Tender";
+  TransactionType2["WILL"] = "W-Will";
+  TransactionType2["IN_THE_MONEY"] = "X-InTheMoney";
+  TransactionType2["TRUST"] = "Z-Trust";
+  return TransactionType2;
+})(TransactionType || {});
+
+exports.Exchange = Exchange;
+exports.Period = Period;
+exports.TransactionType = TransactionType;
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/common.ts","../src/insider.ts"],"names":["Period","Exchange","TransactionType"],"mappings":";;;AAyCO,IAAK,MAAA,qBAAAA,OAAAA,KAAL;AACL,EAAAA,QAAA,QAAA,CAAA,GAAS,QAAA;AACT,EAAAA,QAAA,SAAA,CAAA,GAAU,SAAA;AAFA,EAAA,OAAAA,OAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA;AAKL,IAAK,QAAA,qBAAAC,SAAAA,KAAL;AACL,EAAAA,UAAA,MAAA,CAAA,GAAO,MAAA;AACP,EAAAA,UAAA,QAAA,CAAA,GAAS,QAAA;AACT,EAAAA,UAAA,MAAA,CAAA,GAAO,MAAA;AACP,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AARI,EAAA,OAAAA,SAAAA;AAAA,CAAA,EAAA,QAAA,IAAA,EAAA;;;ACsDL,IAAK,eAAA,qBAAAC,gBAAAA,KAAL;AACL,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AACR,EAAAA,iBAAA,YAAA,CAAA,GAAa,cAAA;AACb,EAAAA,iBAAA,QAAA,CAAA,GAAS,UAAA;AACT,EAAAA,iBAAA,cAAA,CAAA,GAAe,eAAA;AACf,EAAAA,iBAAA,SAAA,CAAA,GAAU,UAAA;AACV,EAAAA,iBAAA,MAAA,CAAA,GAAO,QAAA;AACP,EAAAA,iBAAA,aAAA,CAAA,GAAc,cAAA;AACd,EAAAA,iBAAA,eAAA,CAAA,GAAgB,iBAAA;AAChB,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AACR,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AACR,EAAAA,iBAAA,QAAA,CAAA,GAAS,UAAA;AACT,EAAAA,iBAAA,kBAAA,CAAA,GAAmB,iBAAA;AACnB,EAAAA,iBAAA,UAAA,CAAA,GAAW,YAAA;AACX,EAAAA,iBAAA,MAAA,CAAA,GAAO,QAAA;AACP,EAAAA,iBAAA,QAAA,CAAA,GAAS,UAAA;AACT,EAAAA,iBAAA,MAAA,CAAA,GAAO,QAAA;AACP,EAAAA,iBAAA,cAAA,CAAA,GAAe,cAAA;AACf,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AAlBE,EAAA,OAAAA,gBAAAA;AAAA,CAAA,EAAA,eAAA,IAAA,EAAA","file":"index.js","sourcesContent":["// Common types used across all FMP API endpoints\n\n// Base API response wrapper - consistent structure with nullable fields\nexport interface APIResponse<T = unknown> {\n  success: boolean;\n  data: T | null;\n  error: string | null;\n  status: number;\n}\n\n// FMP API configuration\nexport interface FMPConfig {\n  apiKey?: string; // Optional since we support FMP_API_KEY environment variable\n  timeout?: number;\n}\n\n// Common parameter interfaces\nexport interface SymbolParams {\n  symbol: string;\n}\n\nexport interface DateRangeParams {\n  from?: string;\n  to?: string;\n}\n\nexport interface PaginationParams {\n  limit?: number;\n  page?: number;\n}\n\nexport interface PeriodParams {\n  period?: 'annual' | 'quarter';\n}\n\n// Type-safe query parameters\nexport interface QueryParams {\n  [key: string]: string | number | boolean | undefined;\n}\n\n// Common enums\nexport enum Period {\n  ANNUAL = 'annual',\n  QUARTER = 'quarter',\n}\n\nexport enum Exchange {\n  NYSE = 'NYSE',\n  NASDAQ = 'NASDAQ',\n  AMEX = 'AMEX',\n  TSX = 'TSX',\n  LSE = 'LSE',\n  ASX = 'ASX',\n  NSE = 'NSE',\n  BSE = 'BSE',\n}\n","// Insider Trading Types\n\n// RSS Feed Response\nexport interface InsiderTradingRSSResponse {\n  title: string;\n  fillingDate: string;\n  symbol: string;\n  link: string;\n  reportingCik: string;\n  issuerCik: string;\n}\n\n// Insider Trading Search Response\nexport interface InsiderTradingSearchResponse {\n  symbol: string;\n  filingDate: string;\n  transactionDate: string;\n  reportingCik: string;\n  transactionType: string;\n  securitiesOwned: number;\n  securitiesTransacted: number;\n  companyCik: string;\n  reportingName: string;\n  typeOfOwner: string;\n  link: string;\n  securityName: string;\n  price: number;\n  formType: string;\n  acquistionOrDisposition: string;\n}\n\n// Transaction Types Response\nexport type TransactionTypesResponse = string[];\n\n// Insiders By Symbol Response\nexport interface InsidersBySymbolResponse {\n  typeOfOwner: string;\n  transactionDate: string;\n  owner: string;\n}\n\n// Insider Trade Statistics Response\nexport interface InsiderTradeStatisticsResponse {\n  symbol: string;\n  cik: string;\n  year: number;\n  quarter: number;\n  purchases: number;\n  sales: number;\n  buySellRatio: number;\n  totalBought: number;\n  totalSold: number;\n  averageBought: number;\n  averageSold: number;\n  pPurchases: number;\n  sSales: number;\n}\n\n// CIK Mapper Response\nexport interface CikMapperResponse {\n  reportingCik: string;\n  reportingName: string;\n}\n\n// CIK Mapper By Symbol Response\nexport interface CikMapperBySymbolResponse {\n  symbol: string;\n  companyCik: string;\n}\n\n// Beneficial Ownership Response\nexport interface BeneficialOwnershipResponse {\n  cik: string;\n  symbol: string;\n  filingDate: string;\n  acceptedDate: string;\n  cusip: string;\n  nameOfReportingPerson: string;\n  citizenshipOrPlaceOfOrganization: string;\n  soleVotingPower: string;\n  sharedVotingPower: string;\n  soleDispositivePower: string;\n  sharedDispositivePower: string;\n  amountBeneficiallyOwned: string;\n  percentOfClass: string;\n  typeOfReportingPerson: string;\n  url: string;\n}\n\n// Fail to Deliver Response\nexport interface FailToDeliverResponse {\n  symbol: string;\n  date: string;\n  price: number;\n  quantity: number;\n  cusip: string;\n  name: string;\n}\n\n// Transaction type enum for better type safety\nexport enum TransactionType {\n  AWARD = 'A-Award',\n  CONVERSION = 'C-Conversion',\n  RETURN = 'D-Return',\n  EXPIRE_SHORT = 'E-ExpireShort',\n  IN_KIND = 'F-InKind',\n  GIFT = 'G-Gift',\n  EXPIRE_LONG = 'H-ExpireLong',\n  DISCRETIONARY = 'I-Discretionary',\n  OTHER = 'J-Other',\n  SMALL = 'L-Small',\n  EXEMPT = 'M-Exempt',\n  OUT_OF_THE_MONEY = 'O-OutOfTheMoney',\n  PURCHASE = 'P-Purchase',\n  SALE = 'S-Sale',\n  TENDER = 'U-Tender',\n  WILL = 'W-Will',\n  IN_THE_MONEY = 'X-InTheMoney',\n  TRUST = 'Z-Trust',\n}\n"]}

package/dist/index.mjs

@@ -0,0 +1,44 @@
+// src/common.ts
+var Period = /* @__PURE__ */ ((Period2) => {
+  Period2["ANNUAL"] = "annual";
+  Period2["QUARTER"] = "quarter";
+  return Period2;
+})(Period || {});
+var Exchange = /* @__PURE__ */ ((Exchange2) => {
+  Exchange2["NYSE"] = "NYSE";
+  Exchange2["NASDAQ"] = "NASDAQ";
+  Exchange2["AMEX"] = "AMEX";
+  Exchange2["TSX"] = "TSX";
+  Exchange2["LSE"] = "LSE";
+  Exchange2["ASX"] = "ASX";
+  Exchange2["NSE"] = "NSE";
+  Exchange2["BSE"] = "BSE";
+  return Exchange2;
+})(Exchange || {});
+
+// src/insider.ts
+var TransactionType = /* @__PURE__ */ ((TransactionType2) => {
+  TransactionType2["AWARD"] = "A-Award";
+  TransactionType2["CONVERSION"] = "C-Conversion";
+  TransactionType2["RETURN"] = "D-Return";
+  TransactionType2["EXPIRE_SHORT"] = "E-ExpireShort";
+  TransactionType2["IN_KIND"] = "F-InKind";
+  TransactionType2["GIFT"] = "G-Gift";
+  TransactionType2["EXPIRE_LONG"] = "H-ExpireLong";
+  TransactionType2["DISCRETIONARY"] = "I-Discretionary";
+  TransactionType2["OTHER"] = "J-Other";
+  TransactionType2["SMALL"] = "L-Small";
+  TransactionType2["EXEMPT"] = "M-Exempt";
+  TransactionType2["OUT_OF_THE_MONEY"] = "O-OutOfTheMoney";
+  TransactionType2["PURCHASE"] = "P-Purchase";
+  TransactionType2["SALE"] = "S-Sale";
+  TransactionType2["TENDER"] = "U-Tender";
+  TransactionType2["WILL"] = "W-Will";
+  TransactionType2["IN_THE_MONEY"] = "X-InTheMoney";
+  TransactionType2["TRUST"] = "Z-Trust";
+  return TransactionType2;
+})(TransactionType || {});
+
+export { Exchange, Period, TransactionType };
+//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/common.ts","../src/insider.ts"],"names":["Period","Exchange","TransactionType"],"mappings":";AAyCO,IAAK,MAAA,qBAAAA,OAAAA,KAAL;AACL,EAAAA,QAAA,QAAA,CAAA,GAAS,QAAA;AACT,EAAAA,QAAA,SAAA,CAAA,GAAU,SAAA;AAFA,EAAA,OAAAA,OAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA;AAKL,IAAK,QAAA,qBAAAC,SAAAA,KAAL;AACL,EAAAA,UAAA,MAAA,CAAA,GAAO,MAAA;AACP,EAAAA,UAAA,QAAA,CAAA,GAAS,QAAA;AACT,EAAAA,UAAA,MAAA,CAAA,GAAO,MAAA;AACP,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AARI,EAAA,OAAAA,SAAAA;AAAA,CAAA,EAAA,QAAA,IAAA,EAAA;;;ACsDL,IAAK,eAAA,qBAAAC,gBAAAA,KAAL;AACL,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AACR,EAAAA,iBAAA,YAAA,CAAA,GAAa,cAAA;AACb,EAAAA,iBAAA,QAAA,CAAA,GAAS,UAAA;AACT,EAAAA,iBAAA,cAAA,CAAA,GAAe,eAAA;AACf,EAAAA,iBAAA,SAAA,CAAA,GAAU,UAAA;AACV,EAAAA,iBAAA,MAAA,CAAA,GAAO,QAAA;AACP,EAAAA,iBAAA,aAAA,CAAA,GAAc,cAAA;AACd,EAAAA,iBAAA,eAAA,CAAA,GAAgB,iBAAA;AAChB,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AACR,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AACR,EAAAA,iBAAA,QAAA,CAAA,GAAS,UAAA;AACT,EAAAA,iBAAA,kBAAA,CAAA,GAAmB,iBAAA;AACnB,EAAAA,iBAAA,UAAA,CAAA,GAAW,YAAA;AACX,EAAAA,iBAAA,MAAA,CAAA,GAAO,QAAA;AACP,EAAAA,iBAAA,QAAA,CAAA,GAAS,UAAA;AACT,EAAAA,iBAAA,MAAA,CAAA,GAAO,QAAA;AACP,EAAAA,iBAAA,cAAA,CAAA,GAAe,cAAA;AACf,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AAlBE,EAAA,OAAAA,gBAAAA;AAAA,CAAA,EAAA,eAAA,IAAA,EAAA","file":"index.mjs","sourcesContent":["// Common types used across all FMP API endpoints\n\n// Base API response wrapper - consistent structure with nullable fields\nexport interface APIResponse<T = unknown> {\n  success: boolean;\n  data: T | null;\n  error: string | null;\n  status: number;\n}\n\n// FMP API configuration\nexport interface FMPConfig {\n  apiKey?: string; // Optional since we support FMP_API_KEY environment variable\n  timeout?: number;\n}\n\n// Common parameter interfaces\nexport interface SymbolParams {\n  symbol: string;\n}\n\nexport interface DateRangeParams {\n  from?: string;\n  to?: string;\n}\n\nexport interface PaginationParams {\n  limit?: number;\n  page?: number;\n}\n\nexport interface PeriodParams {\n  period?: 'annual' | 'quarter';\n}\n\n// Type-safe query parameters\nexport interface QueryParams {\n  [key: string]: string | number | boolean | undefined;\n}\n\n// Common enums\nexport enum Period {\n  ANNUAL = 'annual',\n  QUARTER = 'quarter',\n}\n\nexport enum Exchange {\n  NYSE = 'NYSE',\n  NASDAQ = 'NASDAQ',\n  AMEX = 'AMEX',\n  TSX = 'TSX',\n  LSE = 'LSE',\n  ASX = 'ASX',\n  NSE = 'NSE',\n  BSE = 'BSE',\n}\n","// Insider Trading Types\n\n// RSS Feed Response\nexport interface InsiderTradingRSSResponse {\n  title: string;\n  fillingDate: string;\n  symbol: string;\n  link: string;\n  reportingCik: string;\n  issuerCik: string;\n}\n\n// Insider Trading Search Response\nexport interface InsiderTradingSearchResponse {\n  symbol: string;\n  filingDate: string;\n  transactionDate: string;\n  reportingCik: string;\n  transactionType: string;\n  securitiesOwned: number;\n  securitiesTransacted: number;\n  companyCik: string;\n  reportingName: string;\n  typeOfOwner: string;\n  link: string;\n  securityName: string;\n  price: number;\n  formType: string;\n  acquistionOrDisposition: string;\n}\n\n// Transaction Types Response\nexport type TransactionTypesResponse = string[];\n\n// Insiders By Symbol Response\nexport interface InsidersBySymbolResponse {\n  typeOfOwner: string;\n  transactionDate: string;\n  owner: string;\n}\n\n// Insider Trade Statistics Response\nexport interface InsiderTradeStatisticsResponse {\n  symbol: string;\n  cik: string;\n  year: number;\n  quarter: number;\n  purchases: number;\n  sales: number;\n  buySellRatio: number;\n  totalBought: number;\n  totalSold: number;\n  averageBought: number;\n  averageSold: number;\n  pPurchases: number;\n  sSales: number;\n}\n\n// CIK Mapper Response\nexport interface CikMapperResponse {\n  reportingCik: string;\n  reportingName: string;\n}\n\n// CIK Mapper By Symbol Response\nexport interface CikMapperBySymbolResponse {\n  symbol: string;\n  companyCik: string;\n}\n\n// Beneficial Ownership Response\nexport interface BeneficialOwnershipResponse {\n  cik: string;\n  symbol: string;\n  filingDate: string;\n  acceptedDate: string;\n  cusip: string;\n  nameOfReportingPerson: string;\n  citizenshipOrPlaceOfOrganization: string;\n  soleVotingPower: string;\n  sharedVotingPower: string;\n  soleDispositivePower: string;\n  sharedDispositivePower: string;\n  amountBeneficiallyOwned: string;\n  percentOfClass: string;\n  typeOfReportingPerson: string;\n  url: string;\n}\n\n// Fail to Deliver Response\nexport interface FailToDeliverResponse {\n  symbol: string;\n  date: string;\n  price: number;\n  quantity: number;\n  cusip: string;\n  name: string;\n}\n\n// Transaction type enum for better type safety\nexport enum TransactionType {\n  AWARD = 'A-Award',\n  CONVERSION = 'C-Conversion',\n  RETURN = 'D-Return',\n  EXPIRE_SHORT = 'E-ExpireShort',\n  IN_KIND = 'F-InKind',\n  GIFT = 'G-Gift',\n  EXPIRE_LONG = 'H-ExpireLong',\n  DISCRETIONARY = 'I-Discretionary',\n  OTHER = 'J-Other',\n  SMALL = 'L-Small',\n  EXEMPT = 'M-Exempt',\n  OUT_OF_THE_MONEY = 'O-OutOfTheMoney',\n  PURCHASE = 'P-Purchase',\n  SALE = 'S-Sale',\n  TENDER = 'U-Tender',\n  WILL = 'W-Will',\n  IN_THE_MONEY = 'X-InTheMoney',\n  TRUST = 'Z-Trust',\n}\n"]}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "fmp-node-types",
+  "version": "0.1.2",
+  "description": "Shared TypeScript types for FMP Node Wrapper ecosystem (internal package)",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist/**"
+  ],
+  "keywords": [
+    "typescript",
+    "types",
+    "financial",
+    "fmp",
+    "financial-modeling-prep",
+    "internal"
+  ],
+  "author": "Eric <https://github.com/e-roy>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/e-roy/fmp-node-wrapper.git"
+  },
+  "homepage": "https://fmp-node-wrapper-docs.vercel.app",
+  "devDependencies": {
+    "@types/node": "^20.11.0",
+    "prettier": "^3.2.5",
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.3"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "npx eslint src/**/*.ts",
+    "lint:fix": "eslint src/**/*.ts --fix",
+    "type-check": "tsc --noEmit",
+    "format": "prettier --write src/**/*.ts",
+    "format:check": "prettier --check src/**/*.ts",
+    "clean": "rm -rf dist"
+  }
+}