sec-edgar-api 0.2.2 → 0.2.4

package/build/types/parsed-filings.type.d.ts

@@ -67,7 +67,6 @@ export interface ExecutiveCompensation {
     name: string;
     position: string | null;
     year: number | null;
-    positionLevel: 'Executive' | 'Director';
     salaryDollars: number | null;
     bonusDollars: number | null;
     stockAwardDollars: number | null;
@@ -81,155 +80,17 @@ export interface Holder {
     shares: number | null;
     percentOfClass: string | null;
 }
+export interface Form4Data {
+    transactions: InsiderTransaction[];
+}
 export interface Form10KData {
     tables: TableData[];
 }
 export interface Form13GData {
-    institutionalHolders: InstitutionalHolder[];
+    holders: InstitutionalHolder[];
 }
 export interface FormDef14aData {
     executiveCompensation: ExecutiveCompensation[];
-}
-export interface Form4Data {
-    schemaVersion: string;
-    documentType: string;
-    periodOfReport: string;
-    issuerCik: number;
-    issuerName: string;
-    issuerTradingSymbol: string;
-    notSubjectToSection16: boolean;
-    reportingOwners: ReportingOwner[];
-    aff10b5One: boolean;
-    nonDerivativeHolding: NonDerivativeHolding[];
-    nonDerivativeTransaction: NonDerivativeTransaction[];
-    derivativeHolding: DerivativeHolding[];
-    derivativeTransaction: DerivativeTransaction[];
-    footnotes: string[];
-    remarks: string;
-    signatureName: string;
-    signatureDate: string;
-}
-export interface DerivativeHolding {
-    securityTitle: string;
-    directOrIndirectOwnership: string;
-    natureOfOwnership: string | null;
-    sharesOwnedFollowingTransaction: number;
-    conversionOrExercisePrice: number | null;
-    exerciseDate: string | null;
-    expirationDate: string | null;
-    underlyingSecurityShares: number | null;
-    underlyingSecurityTitle: string | null;
-}
-export interface DerivativeTransaction {
-    securityTitle: string;
-    directOrIndirectOwnership: string;
-    natureOfOwnership: string | null;
-    sharesOwnedFollowingTransaction: number;
-    deemedExecutionDate: string | null;
-    equitySwapInvolved: boolean;
-    transactionShares: number;
-    transactionCode: string;
-    transactionFormType: string;
-    transactionDate: string;
-    transactionTimeliness: string | null;
-    transactionPricePerShare: number | null;
-    transactionAcquiredDisposedCode: string;
-    conversionOrExercisePrice: number | null;
-    exerciseDate: string | null;
-    expirationDate: string | null;
-    underlyingSecurityShares: number | null;
-    underlyingSecurityTitle: string | null;
-}
-export interface NonDerivativeHolding {
-    securityTitle: string;
-    directOrIndirectOwnership: string;
-    natureOfOwnership: string | null;
-    sharesOwnedFollowingTransaction: number;
-}
-export interface NonDerivativeTransaction {
-    securityTitle: string;
-    directOrIndirectOwnership: string;
-    natureOfOwnership: string | null;
-    sharesOwnedFollowingTransaction: number;
-    deemedExecutionDate: string | null;
-    equitySwapInvolved: boolean;
-    transactionShares: number;
-    transactionCode: string;
-    transactionFormType: string;
-    transactionDate: string;
-    transactionTimeliness: string | null;
-    transactionPricePerShare: number | null;
-    transactionAcquiredDisposedCode: string;
-}
-export interface ReportingOwner {
-    rptOwnerCity: string;
-    rptOwnerState: string;
-    rptOwnerStateDescription: string;
-    rptOwnerStreet1: string;
-    rptOwnerStreet2: string;
-    rptOwnerZipCode: string;
-    rptOwnerCik: number;
-    rptOwnerName: string;
-    isDirector: boolean;
-    isOfficer: boolean;
-    isTenPercentOwner: boolean;
-    isOther: boolean;
-}
-export interface Form13FData {
-    submissionType: string;
-    periodOfReport: string;
-    cik: number;
-    ccc: string;
-    form13FFileNumber: string;
-    liveTestFlag: string;
-    reportCalendarOrQuarter: string;
-    reportType: string;
-    confirmingCopyFlag: boolean;
-    overrideInternetFlag: boolean;
-    returnCopyFlag: boolean;
-    filingManager: FilingManager;
-    otherManagers: Manager[];
-    provideInfoForInstruction5: string;
-    signatureBlock: SignatureBlock;
-    otherManagers2: Manager[];
-    otherIncludedManagersCount: number;
-    tableEntryTotal: number;
-    tableValueTotal: number;
-    isConfidentialOmitted: boolean;
-    infoTable: InfoTable[];
-}
-export interface FilingManager {
-    name: string;
-    ns1City: string;
-    ns1StateOrCountry: string;
-    ns1Street1: string;
-    ns1ZipCode: string;
-}
-export interface InfoTable {
-    nameOfIssuer: string;
-    titleOfClass: string;
-    cusip: string;
-    value: number;
-    sharesOrPrincipalAmount: number;
-    isPrincipalAmount: boolean;
-    investmentDiscretion: string;
-    votingAuthoritySole: number;
-    votingAuthorityShared: number;
-    votingAuthorityNone: number;
-    otherManagers: number[];
-}
-export interface Manager {
-    sequenceNumber: number | null;
-    name: string;
-    form13FFileNumber: string;
-}
-export interface SignatureBlock {
-    city: string;
-    name: string;
-    phone: string;
-    signature: string;
-    signatureDate: string;
-    stateOrCountry: string;
-    title: string;
+    holders: Holder[];
 }
 export {};

package/build/types/report-raw.type.d.ts

@@ -3,6 +3,8 @@
  */
 export type ReportRaw = {
     [key: string]: string | number | boolean | null;
+    cik: number;
+    url: string | null;
     dateReport: string;
     dateFiled: string;
     fiscalPeriod: FiscalPeriod;
@@ -16,5 +18,5 @@ export type ReportRaw = {
  *
  * for dei, see https://www.sec.gov/structureddata/announcement/osd-announcement-2212-new-2022q4-taxonomies
  */
-export type ReportType = 'QUARTERLY' | 'ANNUAL' | '8K';
+export type ReportType = 'QUARTERLY' | 'ANNUAL' | '8K' | 'DOCUMENT_ENTITY_INFO';
 export type FiscalPeriod = 'Q1' | 'Q2' | 'Q3' | 'Q4' | 'FY';

package/build/types/report-translated.type.d.ts

@@ -1,9 +1,13 @@
 import { FiscalPeriod } from './report-raw.type';
 export interface ReportTranslated {
+    cik: number;
+    url: string | null;
     dateReport: string;
     dateFiled: string;
     fiscalPeriod: FiscalPeriod;
     fiscalYear: number;
+    splitDate: string | null;
+    splitRatio: number | null;
     assetTotal: number | null;
     assetCurrent: number | null;
     assetCurrentCashEquivalents: number | null;
@@ -53,5 +57,4 @@ export interface ReportTranslated {
     cashFlowOperating: number | null;
     cashFlowDeferredTax: number | null;
     cashFlowWorkingCapitalNonCash: number | null;
-    splitRatio: number | null;
 }

package/build/types/submission.type.d.ts

@@ -53,12 +53,11 @@ export interface FilingListItemTranslated {
     primaryDocument: string;
     primaryDocDescription: string;
     url: string;
-    urlXml: string;
 }
-export interface FilingList {
+interface FilingList {
     recent: FilingListDetails;
     files: FileData[];
-    recentTranslated: FilingListItemTranslated[];
+    recentTranslated?: FilingListItemTranslated[];
 }
 export interface SubmissionList {
     cik: number;

package/build/util/key-translations.js

@@ -6,10 +6,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 var keyTranslations = {
     // --- Added from ReportParser --- //
+    cik: ['cik'],
+    url: ['url'],
     dateReport: ['dateReport'],
     dateFiled: ['dateFiled'],
     fiscalPeriod: ['fiscalPeriod'],
     fiscalYear: ['fiscalYear'],
+    splitDate: ['splitDate'],
+    splitRatio: ['StockholdersEquityNoteStockSplitConversionRatio1'],
     // ------------------------------- //
     assetTotal: ['Assets'],
     assetCurrent: ['AssetsCurrent', 'CurrentAssets'],
@@ -92,6 +96,7 @@ var keyTranslations = {
         'ConvertibleLongTermNotesPayable',
         'LongTermNotesAndLoans',
         'DebtAndCapitalLeaseObligations',
+        'LongTermDebtAndCapitalLeaseObligationsIncludingCurrentMaturities',
     ],
     equityTotal: [
         'StockholdersEquity',
@@ -168,6 +173,5 @@ var keyTranslations = {
     cashFlowDeferredTax: ['DeferredIncomeTaxExpenseBenefit'],
     cashFlowWorkingCapitalNonCash: [],
     expenseStockCompensation: ['AllocatedShareBasedCompensationExpense'],
-    splitRatio: ['StockholdersEquityNoteStockSplitConversionRatio1'],
 };
 exports.default = keyTranslations;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "sec-edgar-api",
-    "version": "0.2.2",
+    "version": "0.2.4",
     "description": "Fetch and parse SEC earnings reports and other filings. Useful for financial analysis.",
     "main": "build/index.js",
     "author": "Andrew Evers (https://github.com/andyevers)",
@@ -34,8 +34,5 @@
     },
     "files": [
         "build/**/*"
-    ],
-    "dependencies": {
-        "fast-xml-parser": "^4.5.0"
-    }
+    ]
 }

package/build/services/DocumentParser/HtmlTableExtractor.d.ts

@@ -1,41 +0,0 @@
-export interface Cell {
-    attributes: string;
-    rowSpan: number;
-    colSpan: number;
-    rowIndex: number;
-    colIndex: number;
-    tableCellIndex: number;
-    html: string;
-    isHeaderRowCell: boolean;
-    isBodyTitleRowCell: boolean;
-    valueParsed: string | number | null;
-    headerCol: string | null;
-    headerRowIndex: number | null;
-}
-export interface TableHTMLData {
-    tableIndex: number;
-    parentTableIndex: number | null;
-    childTableIndexes: number[];
-    positionStart: number;
-    positionEnd: number;
-    htmlBefore: string;
-    html: string;
-    rows: Cell[][];
-}
-interface ParseOptions {
-    tagsToExclude?: string[];
-    tagsToInclude?: string[];
-    stripParenthesis?: boolean;
-    stripHtml?: boolean;
-}
-export default class HtmlTableExtractor {
-    extractTables(html: string, options?: ParseOptions): TableHTMLData[];
-    mergeHeaderRows(tables: TableHTMLData[]): void;
-    removeEmptyColumns(tables: TableHTMLData[]): TableHTMLData[];
-    private addTableCells;
-    private addMissingNameCol;
-    private addTableCellValues;
-    stripHtml(str: string, options?: Omit<ParseOptions, 'stripHtml' | 'stripParenthesis'>): string;
-    parseValue(str: string | number | null, options?: ParseOptions): string | number | null;
-}
-export {};