sec-edgar-api 0.4.2 → 0.5.1

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

@@ -1,49 +1,4 @@
-interface TransactionDescriptionByCode {
-    S: 'Sale';
-    V: 'Voluntary Reporting';
-    A: 'Grant';
-    D: 'Sale to Issuer';
-    F: 'Payment of Exercise Price';
-    I: 'Discretionary Transaction';
-    M: 'Conversion of Derivative Exempt';
-    C: 'Conversion of Derivative';
-    E: 'Expiration of Short Derivative Position';
-    H: 'Expiration of Long Derivative Position';
-    O: 'Exercise of out-of-the-money Derivative';
-    X: 'Exercise of in-the-money Derivative';
-    G: 'Gift';
-    L: 'Small Acquisition';
-    W: 'Acquisition or Disposition By Will or Laws';
-    Z: 'Voting Trust Deposit or Withdrawal';
-    J: 'Other Acquisition or Disposition';
-    K: 'Equity Swap';
-    U: 'Disposition Change in Control';
-}
-export type TransactionType = 'Acquire' | 'Dispose';
-export type TransactionCode = keyof TransactionDescriptionByCode;
-export type TransactionDescription = TransactionDescriptionByCode[TransactionCode];
-export interface InsiderTransactionExtended {
-    filerName: string;
-    filerPosition: string;
-    filerPositionTypes: string[];
-    securityType: string;
-    securityTypeUnderlying: string | null;
-    category: 'Derivative' | 'Non-Derivative';
-    date: string;
-    dateExecuted: string | null;
-    dateExpiration: string | null;
-    dateExercisable: string | null;
-    transactionDescription: string | null;
-    transactionCode: TransactionCode | null;
-    transactionType: TransactionType | null;
-    sharesEnding: number | null;
-    shares: number | null;
-    sharesUnderlying: number | null;
-    price: number | null;
-    priceExcercised: number | null;
-    ownership: string;
-    explainationByKey: Partial<Record<keyof InsiderTransactionExtended, string>>;
-}
+import type { InsiderTransactionExtended } from './insider-transaction.type';
 export interface InstitutionalHolder {
     name: string;
     origin: string;
@@ -94,4 +49,3 @@ export interface FormDef14aData {
     holders: Holder[];
 }
 export type DailyFilingFormType = '10-K' | '10-Q' | '8-K' | '14' | '485' | 'S-8' | 'ALL';
-export {};

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

@@ -1,4 +1,4 @@
-import { FiscalPeriod } from './report-raw.type';
+import type { FiscalPeriod } from './report-raw.type';
 export interface ReportTranslated {
     cik: number;
     url: string | null;
@@ -28,7 +28,6 @@ export interface ReportTranslated {
     liabilityNonCurrentDebt: number | null;
     equityTotal: number | null;
     equityRetainedEarnings: number | null;
-    equityStockPreferred: number | null;
     sharesOutstanding: number | null;
     sharesOutstandingDiluted: number | null;
     eps: number | null;
@@ -48,13 +47,17 @@ export interface ReportTranslated {
     expenseDepreciationAccumulated: number | null;
     expenseStockCompensation: number | null;
     expenseNonCashOther: number | null;
+    expenseSellingGeneralAdministrative: number | null;
     incomeOperating: number | null;
     incomeNet: number | null;
+    incomePretax: number | null;
     cashFlowFree: number | null;
     cashFlowDividendsPaid: number | null;
     cashFlowDividendsPaidPreferred: number | null;
-    cashFlowCapex: number | null;
     cashFlowOperating: number | null;
+    cashFlowInvesting: number | null;
+    cashFlowFinancing: number | null;
+    cashFlowCapex: number | null;
     cashFlowDeferredTax: number | null;
     cashFlowWorkingCapitalNonCash: number | null;
 }

package/build/util/calculation-map.d.ts

@@ -0,0 +1,2 @@
+import { CalculationMapCondensed, ReportTranslated } from '../types';
+export declare const calculationMapCondensed: CalculationMapCondensed<ReportTranslated>;

package/build/util/calculation-map.js

@@ -0,0 +1,292 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculationMapCondensed = void 0;
+exports.calculationMapCondensed = {
+    cik: [],
+    url: [],
+    dateReport: [],
+    dateFiled: [],
+    fiscalPeriod: [],
+    fiscalYear: [],
+    splitDate: [],
+    splitRatio: [],
+    assetCurrent: [[['us-gaap:AssetsCurrent', 1, 0]]],
+    assetCurrentAccountsReceivable: [
+        [['us-gaap:AccountsReceivableNetCurrent', 1, 0]],
+        [['ReceivablesNetCurrent', 1, 0]],
+        [['AccountsReceivableNet', 1, 0]],
+        [['AccountsNotesAndLoansReceivableNetCurrent', 1, 0]],
+        [['AccountsAndOtherReceivablesNetCurrent', 1, 0]],
+    ],
+    assetCurrentCashEquivalents: [
+        [['us-gaap:CashAndCashEquivalentsAtCarryingValue', 1, 0]],
+        [['us-gaap:CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalents', 1, 0]],
+        [['us-gaap:CashAndDueFromBanks', 1, 0]],
+    ],
+    assetCurrentInventory: [[['us-gaap:InventoryNet', 1, 0]]],
+    assetCurrentInvestments: [[['us-gaap:MarketableSecuritiesCurrent', 1, 0]]],
+    assetNonCurrent: [
+        [
+            ['us-gaap:AssetsCurrent', -1, 0],
+            ['us-gaap:Assets', 1, 0],
+        ],
+    ],
+    assetNonCurrentGoodwill: [[['us-gaap:Goodwill', 1, 0]]],
+    assetNonCurrentIntangibleLessGoodwill: [
+        [['us-gaap:IntangibleAssetsNetExcludingGoodwill', 1, 0]],
+        [
+            ['us-gaap:FiniteLivedIntangibleAssetsNet', 1, 0],
+            ['us-gaap:IndefiniteLivedIntangibleAssetsExcludingGoodwill', 1, 0],
+        ],
+    ],
+    assetNonCurrentInvestments: [
+        [['us-gaap:LongTermInvestments', 1, 0]],
+        [['us-gaap:InvestmentsInAffiliatesSubsidiariesAssociatesAndJointVentures', 1, 0]],
+        [['us-gaap:EquityMethodInvestments', 1, 0]],
+    ],
+    assetNonCurrentPPEGross: [
+        [
+            ['expenseDepreciationAccumulated', 1, 0],
+            ['assetNonCurrentPPENet', 1, 0],
+        ],
+    ],
+    assetNonCurrentPPENet: [
+        [['us-gaap:PropertyPlantAndEquipmentNet', 1, 0]],
+        [
+            ['us-gaap:OperatingLeaseRightOfUseAsset', 1, 0],
+            [
+                'us-gaap:PropertyPlantAndEquipmentAndFinanceLeaseRightOfUseAssetAfterAccumulatedDepreciationAndAmortization',
+                1,
+                0,
+            ],
+        ],
+        [
+            ['us-gaap:CapitalizedContractCostNetNoncurrent', 1, 0],
+            ['us-gaap:OperatingLeaseRightOfUseAsset', 1, 0],
+            ['us-gaap:PropertyPlantAndEquipmentNet', 1, 0],
+        ],
+    ],
+    assetTotal: [[['us-gaap:LiabilitiesAndStockholdersEquity', 1, 0]], [['us-gaap:Assets', 1, 0]]],
+    cashFlowCapex: [[['us-gaap:PaymentsToAcquirePropertyPlantAndEquipment', 1, 0]]],
+    cashFlowDeferredTax: [
+        [
+            ['us-gaap:DeferredIncomeTaxExpenseBenefit', 1, 0],
+            ['us-gaap:ProfitLoss', 1, 0],
+        ],
+    ],
+    cashFlowDividendsPaid: [
+        [['us-gaap:PaymentsOfDividends', 1, 0]],
+        [['us-gaap:PaymentsOfDividendsCommonStock', 1, 0]],
+    ],
+    cashFlowDividendsPaidPreferred: [[['us-gaap:DividendsPreferredStock', 1, 0]]],
+    cashFlowFinancing: [[['us-gaap:NetCashProvidedByUsedInFinancingActivities', 1, 0]]],
+    cashFlowFree: [
+        [
+            ['cashFlowCapex', -1, 1],
+            ['cashFlowOperating', 1, 1],
+        ],
+    ],
+    cashFlowInvesting: [[['us-gaap:NetCashProvidedByUsedInInvestingActivities', 1, 0]]],
+    cashFlowOperating: [[['us-gaap:NetCashProvidedByUsedInOperatingActivities', 1, 0]]],
+    cashFlowWorkingCapitalNonCash: [
+        [
+            ['assetCurrent', 1, 1],
+            ['assetCurrentCashEquivalents', -1, 1],
+            ['liabilityCurrent', -1, 1],
+            ['liabilityCurrentDebt', 1, 0],
+        ],
+    ],
+    ebit: [
+        [
+            ['expenseInterest', 1, 0],
+            ['incomeNet', 1, 0],
+            ['expenseTax', 1, 0],
+        ],
+    ],
+    ebitda: [
+        [
+            ['expenseDepreciation', 1, 0],
+            ['expenseTax', 1, 0],
+            ['expenseInterest', 1, 0],
+            ['incomeNet', 1, 1],
+        ],
+    ],
+    eps: [[['us-gaap:EarningsPerShareBasic', 1, 0]]],
+    epsDiluted: [[['us-gaap:EarningsPerShareDiluted', 1, 0]]],
+    equityRetainedEarnings: [[['us-gaap:RetainedEarningsAccumulatedDeficit', 1, 0]]],
+    equityTotal: [
+        [['us-gaap:StockholdersEquity', 1, 0]],
+        [['us-gaap:StockholdersEquityIncludingPortionAttributableToNoncontrollingInterest', 1, 0]],
+    ],
+    expenseDepreciation: [
+        [['us-gaap:DepreciationDepletionAndAmortization', 1, 0]],
+        [['us-gaap:DepreciationAndAmortization', 1, 0]],
+        [
+            ['us-gaap:Depreciation', 1, 0],
+            ['us-gaap:AmortizationOfIntangibleAssets', 1, 0],
+        ],
+        [
+            ['us-gaap:DepreciationAmortizationAndAccretionNet', 1, 0],
+            ['us-gaap:OtherAmortizationOfDeferredCharges', 1, 0],
+        ],
+        [
+            ['us-gaap:AssetRetirementObligationAccretionExpense', 1, 0],
+            ['us-gaap:DepreciationDepletionAndAmortization', 1, 0],
+            ['us-gaap:GainLossOnSaleOfPropertyPlantEquipment', -1, 0],
+        ],
+    ],
+    expenseDepreciationAccumulated: [
+        [['us-gaap:AccumulatedDepreciationDepletionAndAmortizationPropertyPlantAndEquipment', 1, 0]],
+        [
+            [
+                'us-gaap:PropertyPlantAndEquipmentAndFinanceLeaseRightOfUseAssetAccumulatedDepreciationAndAmortization',
+                1,
+                0,
+            ],
+        ],
+        [
+            [
+                'us-gaap:PropertyPlantAndEquipmentAndFinanceLeaseRightOfUseAssetAfterAccumulatedDepreciationAndAmortization',
+                1,
+                0,
+            ],
+            [
+                'us-gaap:PropertyPlantAndEquipmentAndFinanceLeaseRightOfUseAssetBeforeAccumulatedDepreciationAndAmortization',
+                -1,
+                0,
+            ],
+        ],
+        [
+            ['assetNonCurrentPPEGross', 1, 1],
+            ['assetNonCurrentPPENet', -1, 1],
+        ],
+    ],
+    expenseInterest: [[['us-gaap:InterestExpense', 1, 0]]],
+    expenseNonCashOther: [
+        [
+            ['us-gaap:AmortizationOfFinancingCosts', -1, 0],
+            ['us-gaap:OperatingLeaseRightOfUseAssetAmortizationExpense', -1, 0],
+            ['us-gaap:OtherNoncashIncomeExpense', 1, 1],
+        ],
+        [
+            ['us-gaap:RepaymentsOfLongTermDebt', 1, 1],
+            ['us-gaap:ProceedsFromRepaymentsOfShortTermDebtMaturingInThreeMonthsOrLess', -1, 0],
+            ['us-gaap:ProceedsFromShortTermDebtMaturingInMoreThanThreeMonths', -1, 0],
+        ],
+    ],
+    expenseOperating: [
+        [['us-gaap:OperatingExpenses', 1, 1]],
+        [
+            ['expenseSellingGeneralAdministrative', 1, 1],
+            ['expenseResearchDevelopment', 1, 0],
+            ['expenseDepreciation', 1, 0],
+            ['us-gaap:ProvisionForDoubtfulAccounts', 1, 0],
+        ],
+    ],
+    expenseResearchDevelopment: [[['us-gaap:ResearchAndDevelopmentExpense', 1, 0]]],
+    expenseSellingGeneralAdministrative: [
+        [['us-gaap:SellingGeneralAndAdministrativeExpense', 1, 0]],
+        [
+            ['us-gaap:GeneralAndAdministrativeExpense', 1, 0],
+            ['us-gaap:SellingAndMarketingExpense', 1, 0],
+        ],
+    ],
+    expenseStockCompensation: [[['us-gaap:ShareBasedCompensation', 1, 0]]],
+    expenseTax: [[['us-gaap:IncomeTaxExpenseBenefit', 1, 0]]],
+    expenseTotal: [
+        [
+            ['incomeNet', -1, 1],
+            ['revenueTotal', 1, 1],
+        ],
+        [['us-gaap:CostsAndExpenses', 1, 1]],
+    ],
+    incomeNet: [
+        [['us-gaap:NetIncomeLoss', 1, 1]],
+        [
+            ['incomePretax', 1, 1],
+            ['expenseTax', -1, 1],
+        ],
+    ],
+    incomeOperating: [[['us-gaap:OperatingIncomeLoss', 1, 1]]],
+    incomePretax: [
+        [
+            ['us-gaap:OperatingIncomeLoss', 1, 0],
+            ['us-gaap:NonoperatingIncomeExpense', 1, 0],
+        ],
+        [['us-gaap:IncomeLossFromContinuingOperationsBeforeIncomeTaxesExtraordinaryItemsNoncontrollingInterest', 1, 0]],
+    ],
+    liabilityCurrent: [[['us-gaap:LiabilitiesCurrent', 1, 0]]],
+    liabilityCurrentAccountsPayable: [[['us-gaap:AccountsPayableCurrent', 1, 0]]],
+    liabilityCurrentDebt: [
+        [['us-gaap:DebtCurrent', 1, 1]],
+        [
+            ['us-gaap:LongTermDebtAndCapitalLeaseObligationsCurrent', 1, 1],
+            ['us-gaap:ShortTermBorrowings', 1, 0],
+        ],
+        [
+            ['us-gaap:LongTermDebtCurrent', 1, 1],
+            ['us-gaap:FinanceLeaseLiabilityCurrent', 1, 0],
+            ['us-gaap:ShortTermBorrowings', 1, 0],
+        ],
+        [['us-gaap:ShortTermBorrowings', 1, 0]],
+    ],
+    liabilityNonCurrent: [
+        [['us-gaap:LiabilitiesNoncurrent', 1, 0]],
+        [
+            ['liabilityTotal', 1, 1],
+            ['liabilityCurrent', -1, 1],
+        ],
+    ],
+    liabilityNonCurrentDebt: [
+        [['us-gaap:LongTermDebtNoncurrent', 1, 0]],
+        [['us-gaap:LongTermDebtAndCapitalLeaseObligations', 1, 0]],
+    ],
+    liabilityTotal: [
+        [['us-gaap:Liabilities', 1, 0]],
+        [
+            ['us-gaap:LiabilitiesCurrent', 1, 0],
+            ['us-gaap:LiabilitiesNoncurrent', 1, 0],
+        ],
+    ],
+    profitGross: [
+        [['us-gaap:GrossProfit', 1, 0]],
+        [
+            ['revenueTotal', 1, 0],
+            ['revenueCost', -1, 0],
+        ],
+    ],
+    revenueCost: [
+        [['us-gaap:CostOfRevenue', 1, 0]],
+        [['us-gaap:CostOfGoodsAndServicesSold', 1, 0]],
+        [['us-gaap:CostOfGoodsAndServiceExcludingDepreciationDepletionAndAmortization', -1, 0]],
+    ],
+    revenueOperating: [
+        [
+            ['us-gaap:CostOfGoodsAndServiceExcludingDepreciationDepletionAndAmortization', -1, 0],
+            ['us-gaap:RevenueFromContractWithCustomerExcludingAssessedTax', 1, 0],
+        ],
+        [
+            ['revenueCost', 1, 1],
+            ['profitGross', 1, 1],
+        ],
+    ],
+    revenueTotal: [
+        [['us-gaap:Revenues', 1, 1]],
+        [
+            ['us-gaap:CostOfGoodsAndServiceExcludingDepreciationDepletionAndAmortization', -1, 0],
+            ['us-gaap:RevenueFromContractWithCustomerExcludingAssessedTax', 1, 1],
+        ],
+        [['us-gaap:RevenueFromContractWithCustomerIncludingAssessedTax', 1, 1]],
+        [['ifrs-full:Revenue', 1, 1]],
+        [
+            ['revenueCost', 1, 1],
+            ['profitGross', 1, 1],
+        ],
+    ],
+    sharesOutstanding: [
+        [['us-gaap:WeightedAverageNumberOfSharesOutstandingBasic', 1, 0]],
+        [['us-gaap:CommonStockSharesOutstanding', 1, 0]],
+        [['dei:EntityCommonStockSharesOutstanding', 1, 0]],
+    ],
+    sharesOutstandingDiluted: [[['us-gaap:WeightedAverageNumberOfDilutedSharesOutstanding', 1, 0]]],
+};

package/build/util/key-translations.d.ts

@@ -1,4 +1,4 @@
-import { ReportTranslated } from '../types/report-translated.type';
+import type { ReportTranslated } from '../types/report-translated.type';
 /**
  * Checks if any of the array keys exist in the object to assign to the translated key
  * These were checked against Yahoo Finance values, adding the ones that most often matched the yahoo values

package/build/util/key-translations.js

@@ -104,18 +104,14 @@ var keyTranslations = {
         'EquityAttributableToOwnersOfParent',
     ],
     equityRetainedEarnings: ['RetainedEarningsAccumulatedDeficit', 'RetainedEarnings'],
-    equityStockPreferred: [
-    // TODO: Add this
-    ],
     sharesOutstanding: ['WeightedAverageNumberOfSharesOutstandingBasic', 'CommonStockSharesOutstanding'],
     sharesOutstandingDiluted: ['WeightedAverageNumberOfDilutedSharesOutstanding'],
     eps: ['EarningsPerShareBasic', 'EarningsPerShareBasicAndDiluted'],
     epsDiluted: ['EarningsPerShareDiluted', 'EarningsPerShareBasicAndDiluted'],
-    ebit: ['OperatingIncomeLoss'],
+    ebit: [],
     ebitda: [],
     profitGross: ['GrossProfit'],
     revenueTotal: [
-        // 'RevenueFromContractWithCustomerExcludingAssessedTax',
         'RevenueFromContractWithCustomerExcludingAssessedTax',
         'Revenues',
         'RevenueFromContractWithCustomerIncludingAssessedTax',
@@ -135,8 +131,8 @@ var keyTranslations = {
         'ResearchAndDevelopmentExpenseSoftwareExcludingAcquiredInProcessCost',
     ],
     expenseInterest: [
-        'InterestIncomeExpenseNet',
         'InterestExpense',
+        'InterestIncomeExpenseNet',
         'InterestIncomeExpenseNonoperatingNet',
         'InterestRevenueExpenseNet',
     ],
@@ -152,6 +148,7 @@ var keyTranslations = {
     expenseDepreciationAccumulated: ['AccumulatedDepreciationDepletionAndAmortizationPropertyPlantAndEquipment'],
     expenseTax: ['IncomeTaxExpenseBenefit', 'IncomeTaxExpenseContinuingOperations'],
     expenseNonCashOther: ['OtherNoncashIncomeExpense'],
+    expenseSellingGeneralAdministrative: ['SellingGeneralAndAdministrativeExpense'],
     incomeOperating: [
         'OperatingIncomeLoss',
         'IncomeLossFromContinuingOperationsBeforeIncomeTaxesExtraordinaryItemsNoncontrollingInterest',
@@ -170,8 +167,11 @@ var keyTranslations = {
     cashFlowDividendsPaidPreferred: ['DividendsPreferredStock'],
     cashFlowCapex: ['PaymentsToAcquirePropertyPlantAndEquipment'],
     cashFlowOperating: ['NetCashProvidedByUsedInOperatingActivities'],
+    cashFlowInvesting: ['NetCashProvidedByUsedInInvestingActivities'],
+    cashFlowFinancing: ['NetCashProvidedByUsedInFinancingActivities'],
     cashFlowDeferredTax: ['DeferredIncomeTaxExpenseBenefit'],
     cashFlowWorkingCapitalNonCash: [],
     expenseStockCompensation: ['AllocatedShareBasedCompensationExpense'],
+    incomePretax: [],
 };
 exports.default = keyTranslations;

package/build/util/util-map.d.ts

@@ -0,0 +1,12 @@
+import type { CalculationMap, CalculationMapCondensed } from '../types/calculation-map.type';
+declare function expandMap<T>(map: CalculationMapCondensed<T>): CalculationMap<T>;
+declare function condenseMap<T>(map: CalculationMap<T>): CalculationMapCondensed<T>;
+/**
+ * Used for expanding and condensing calculation maps. Calculation maps are used in secEdgarApi.getReports
+ * to map values from the SEC to the reports.
+ */
+export declare const utilMap: {
+    expandMap: typeof expandMap;
+    condenseMap: typeof condenseMap;
+};
+export {};

package/build/util/util-map.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.utilMap = void 0;
+function expandMap(map) {
+    var _a, _b;
+    var mapExpanded = {};
+    for (var key in map) {
+        var groups = [];
+        for (var _i = 0, _c = map[key]; _i < _c.length; _i++) {
+            var group = _c[_i];
+            var calculations = [];
+            for (var _d = 0, group_1 = group; _d < group_1.length; _d++) {
+                var calculation = group_1[_d];
+                var key_1 = calculation[0];
+                var weight = Number((_a = calculation[1]) !== null && _a !== void 0 ? _a : 1);
+                var isRequired = Boolean((_b = calculation[2]) !== null && _b !== void 0 ? _b : false);
+                calculations.push({ key: key_1, weight: weight, isRequired: isRequired });
+            }
+            groups.push({ calculation: calculations });
+        }
+        mapExpanded[key] = { groups: groups };
+    }
+    return mapExpanded;
+}
+function condenseMap(map) {
+    var mapCondensed = {};
+    for (var key in map) {
+        var groupsArr = [];
+        for (var _i = 0, _a = map[key].groups; _i < _a.length; _i++) {
+            var group = _a[_i];
+            var groupArr = [];
+            for (var _b = 0, _c = group.calculation; _b < _c.length; _b++) {
+                var _d = _c[_b], key_2 = _d.key, weight = _d.weight, isRequired = _d.isRequired;
+                var row = [key_2, weight, Number(isRequired)];
+                groupArr.push(row);
+            }
+            groupsArr.push(groupArr);
+        }
+        mapCondensed[key] = groupsArr;
+    }
+    return mapCondensed;
+}
+/**
+ * Used for expanding and condensing calculation maps. Calculation maps are used in secEdgarApi.getReports
+ * to map values from the SEC to the reports.
+ */
+exports.utilMap = {
+    expandMap: expandMap,
+    condenseMap: condenseMap,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "sec-edgar-api",
-    "version": "0.4.2",
+    "version": "0.5.1",
     "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)",