sec-edgar-api 0.4.2 → 0.5.1

package/build/services/ReportParser/ReportResolvable.js

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var ReportResolvable = /** @class */ (function () {
+    function ReportResolvable(args) {
+        this.calculationMap = {};
+        this.keyStack = new Set();
+        this.calculatedValues = new Map();
+        this.usedGroupIndexesByKey = new Map();
+        this.depth = 0;
+        var report = args.report, calculationMap = args.calculationMap;
+        this.calculationMap = calculationMap !== null && calculationMap !== void 0 ? calculationMap : {};
+        this.report = report;
+        this.usedGroupIndexesByKey = new Map();
+    }
+    ReportResolvable.prototype.getMap = function () {
+        return this.calculationMap;
+    };
+    ReportResolvable.prototype.clearCache = function () {
+        this.calculatedValues.clear();
+    };
+    /**
+     * Used when testing to remove groups that are not being used.
+     */
+    ReportResolvable.prototype.getUsedGroupIndexesByKey = function () {
+        var obj = {};
+        this.usedGroupIndexesByKey.forEach(function (indexes, key) { return (obj[key] = Array.from(indexes)); });
+        return obj;
+    };
+    /**
+     * Gets value from report, or calculates it using calculationMap.
+     */
+    ReportResolvable.prototype.get = function (key) {
+        this.depth = 0;
+        return this._get(key);
+    };
+    /**
+     * Returns 0 for non-numeric values
+     */
+    ReportResolvable.prototype.getNumber = function (key) {
+        return Number(this.get(key)) || 0;
+    };
+    ReportResolvable.prototype.getCalculatedFromGroup = function (params) {
+        this.depth = 0;
+        return this._getCalculatedFromGroup(params);
+    };
+    ReportResolvable.prototype._get = function (key, parentKey) {
+        var _a, _b;
+        return (_a = this.report[key]) !== null && _a !== void 0 ? _a : ((_b = this._getCalculated(key, parentKey)) !== null && _b !== void 0 ? _b : {}).value;
+    };
+    ReportResolvable.prototype._getCalculatedFromGroup = function (params, parentKey, skipSingleMatch) {
+        var _a;
+        if (skipSingleMatch === void 0) { skipSingleMatch = false; }
+        var group = params.group, _b = params.breakIfMissingRequiredKey, breakIfMissingRequiredKey = _b === void 0 ? true : _b;
+        var calculation = group.calculation;
+        var hasAtLeastOneKey = false;
+        var isMissingRequiredKey = false;
+        var missingKeys = [];
+        var finalSum = 0;
+        for (var _i = 0, calculation_1 = calculation; _i < calculation_1.length; _i++) {
+            var item = calculation_1[_i];
+            if (skipSingleMatch && calculation.length < 2)
+                continue;
+            var childKey = item.key, weight = item.weight, isRequired = item.isRequired;
+            var value = (_a = this._get(childKey, parentKey)) !== null && _a !== void 0 ? _a : null;
+            var hasKey = typeof value === 'number';
+            hasAtLeastOneKey = hasAtLeastOneKey || hasKey;
+            isMissingRequiredKey = isMissingRequiredKey || (isRequired && !hasKey);
+            if (!hasKey) {
+                missingKeys.push(childKey);
+            }
+            if (isMissingRequiredKey && breakIfMissingRequiredKey) {
+                break;
+            }
+            var valueAdjusted = (Number(value) || 0) * weight;
+            finalSum += valueAdjusted;
+        }
+        return { hasAtLeastOneKey: hasAtLeastOneKey, isMissingRequiredKey: isMissingRequiredKey, missingKeys: missingKeys, value: hasAtLeastOneKey ? finalSum : null };
+    };
+    /**
+     * @param skipSingleMatch When true, skips groups that match only one key. Used for testing groups.
+     */
+    ReportResolvable.prototype.getCalculated = function (key, skipSingleMatch) {
+        var _a;
+        if (skipSingleMatch === void 0) { skipSingleMatch = false; }
+        this.depth = 0;
+        return (_a = this._getCalculated(key, undefined, skipSingleMatch)) !== null && _a !== void 0 ? _a : { value: null, groupIndex: -1 };
+    };
+    ReportResolvable.prototype._getCalculated = function (key, parentKey, skipSingleMatch) {
+        var _a, _b, _c, _d, _e;
+        if (skipSingleMatch === void 0) { skipSingleMatch = false; }
+        this.depth++;
+        if (this.report[key] !== undefined && !skipSingleMatch) {
+            return { value: this.report[key], groupIndex: -1 };
+        }
+        if (this.calculatedValues.has(key)) {
+            var calculatedValue = this.calculatedValues.get(key);
+            var calculatedLength = (_b = (_a = this.calculationMap[key]) === null || _a === void 0 ? void 0 : _a.groups[calculatedValue === null || calculatedValue === void 0 ? void 0 : calculatedValue.groupIndex]) === null || _b === void 0 ? void 0 : _b.calculation.length;
+            if (!skipSingleMatch || calculatedLength > 1)
+                return calculatedValue;
+        }
+        if (this.keyStack.has(key) || this.depth >= 50) {
+            return null;
+        }
+        this.keyStack.add(key);
+        var calculationOptions = (_c = this.calculationMap[key]) !== null && _c !== void 0 ? _c : { isTranslation: true, groups: [] };
+        var result = null;
+        var calculationGroups = (_d = calculationOptions.groups) !== null && _d !== void 0 ? _d : [];
+        for (var i = 0; i < calculationGroups.length; i++) {
+            var group = calculationGroups[i];
+            var _f = this._getCalculatedFromGroup({
+                group: group,
+                breakIfMissingRequiredKey: true,
+            }, key, skipSingleMatch), hasAtLeastOneKey = _f.hasAtLeastOneKey, isMissingRequiredKey = _f.isMissingRequiredKey, value = _f.value;
+            if (!hasAtLeastOneKey || isMissingRequiredKey || typeof value !== 'number') {
+                continue;
+            }
+            var groupResult = { value: value, groupIndex: i };
+            // used for dev purposes to see which groups are being used.
+            var indexBucket = ((_e = this.usedGroupIndexesByKey.get(key)) !== null && _e !== void 0 ? _e : this.usedGroupIndexesByKey.set(key, new Set()).get(key));
+            indexBucket.add(i);
+            result = groupResult;
+            break;
+        }
+        if (parentKey === undefined && !skipSingleMatch) {
+            this.calculatedValues.set(key, result);
+        }
+        this.keyStack.delete(key);
+        return result;
+    };
+    ReportResolvable.prototype.toJSON = function () {
+        return this.report;
+    };
+    return ReportResolvable;
+}());
+exports.default = ReportResolvable;

package/build/services/ReportParser/ReportTranslatedProxy.d.ts

@@ -1,4 +1,4 @@
-import { ReportTranslated } from '../../types';
+import type { ReportTranslated } from '../../types';
 type ExtendableReportProxy = {
     new (report: ReportTranslated): ReportTranslated;
 };

package/build/services/ReportParser/ReportWrapper.d.ts

@@ -1,4 +1,4 @@
-import { FiscalPeriod, ReportRaw, ReportTranslated } from '../../types';
+import type { FiscalPeriod, ReportRaw, ReportTranslated } from '../../types';
 import ReportTranslatedProxy from './ReportTranslatedProxy';
 /**
  * Contains translated report and raw report with methods to access other reports

package/build/services/ReportParser/resolvers/resolve-ebit.js

@@ -7,6 +7,12 @@ function resolveEbit(report) {
         report.ebit = report.incomeOperating;
         return;
     }
+    if (!report.ebit && report.incomeNet && report.expenseTax) {
+        report.ebit = report.incomeNet + report.expenseTax;
+    }
+    if (!report.ebitda && report.ebit && report.expenseDepreciation) {
+        report.ebitda = report.ebit + report.expenseDepreciation;
+    }
     var _a = report, ebit = _a.ebit, expenseDepreciation = _a.expenseDepreciation, ebitda = _a.ebitda;
     var nullKey = (0, helpers_1.getSingleNullKey)({ ebit: ebit, expenseDepreciation: expenseDepreciation, ebitda: ebitda });
     switch (nullKey) {

package/build/services/ReportParser/resolvers/resolve-q4-fiscal-year-matching-properties.js

@@ -28,7 +28,6 @@ function resolveQ4FiscalYearMatchingProperties(reportWrapper) {
         'liabilityNonCurrentDebt',
         'liabilityTotal',
         'equityRetainedEarnings',
-        'equityStockPreferred',
         'equityTotal',
         'dateFiled',
         'dateReport',

package/build/services/ReportRawBuilder/FactFiscalCalculator.d.ts

@@ -1,3 +1,4 @@
+import type { FactItem, FilingListItemTranslated } from '../../types';
 export interface SetReportDatesParams {
     year: number;
     quarter: number;
@@ -17,6 +18,13 @@ export default class FactFiscalCalculator {
     private readonly endDateCountMap;
     private readonly filedDateCountByEndDate;
     private didResolve;
+    constructor(params?: {
+        facts?: Pick<FactItem, 'end' | 'filed'>[];
+        filings?: Pick<FilingListItemTranslated, 'form' | 'reportDate' | 'filingDate' | 'accessionNumber'>[];
+    });
+    useFilingsForDates(params: {
+        filings: Pick<FilingListItemTranslated, 'form' | 'reportDate' | 'filingDate' | 'accessionNumber'>[];
+    }): void;
     add(fact: {
         end: string;
         filed: string;

package/build/services/ReportRawBuilder/FactFiscalCalculator.js

@@ -5,7 +5,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * Then measures the offset from the end date to the next/previous fiscal year end.
  */
 var FactFiscalCalculator = /** @class */ (function () {
-    function FactFiscalCalculator() {
+    function FactFiscalCalculator(params) {
+        var _this = this;
         this.endDateByYear = new Map();
         this.fiscalsByEndDate = new Map();
         this.datesByFiscals = new Map();
@@ -13,7 +14,39 @@ var FactFiscalCalculator = /** @class */ (function () {
         this.endDateCountMap = new Map();
         this.filedDateCountByEndDate = new Map();
         this.didResolve = false;
+        var _a = params !== null && params !== void 0 ? params : {}, _b = _a.facts, facts = _b === void 0 ? [] : _b, _c = _a.filings, filings = _c === void 0 ? [] : _c;
+        if (filings.length > 0) {
+            this.useFilingsForDates({ filings: filings });
+        }
+        facts.forEach(function (fact) { return _this.add(fact); });
     }
+    FactFiscalCalculator.prototype.useFilingsForDates = function (params) {
+        var _this = this;
+        var filings = params.filings;
+        var endDateByYear = new Map();
+        filings.forEach(function (_a) {
+            var reportDate = _a.reportDate, form = _a.form;
+            if (form === '10-K' || form === '20-F') {
+                endDateByYear.set(Number(reportDate.substring(0, 4)), new Date(reportDate));
+            }
+        });
+        filings.forEach(function (filing) {
+            if (filing.form === '10-K' || filing.form === '10-Q' || filing.form === '20-F' || filing.form === '40-F') {
+                var _a = _this.getFiscalYearQuarter({
+                    dateStr: filing.reportDate,
+                    endDateByYear: endDateByYear,
+                }), quarter = _a.quarter, year = _a.year;
+                _this.setReportDates({
+                    accn: filing.accessionNumber,
+                    end: filing.reportDate,
+                    filed: filing.filingDate,
+                    isAnnual: filing.form === '10-K' || filing.form === '20-F',
+                    quarter: quarter,
+                    year: year,
+                });
+            }
+        });
+    };
     FactFiscalCalculator.prototype.add = function (fact) {
         var _a, _b, _c;
         var end = fact.end, filed = fact.filed;

package/build/services/ReportRawBuilder/FactGrouper.d.ts

@@ -1,4 +1,4 @@
-import { FactItem, FactGroup, SplitData } from '../../types';
+import type { FactItem, FactGroup, SplitData } from '../../types';
 import FactFiscalCalculator from './FactFiscalCalculator';
 /**
  * There are many facts properties for the same period but filed at different times.

package/build/services/ReportRawBuilder/FactPeriodResolver.d.ts

@@ -1,4 +1,4 @@
-import { FiscalPeriod } from '../../types/report-raw.type';
+import type { FiscalPeriod } from '../../types/report-raw.type';
 /**
  * Resolves quarterly and annual values for a property. This is because filers provide total values for the
  * current fiscal year, rather than values for the individual quarters

package/build/services/ReportRawBuilder/FactRecordBuilder.d.ts

@@ -1,4 +1,4 @@
-import { CompanyFactListData, FactItem } from '../../types';
+import type { CompanyFactListData, FactItem } from '../../types';
 /**
  * Builds an array of fact records.
  */

package/build/services/ReportRawBuilder/FactSplitAdjuster.d.ts

@@ -1,4 +1,4 @@
-import { CompanyFactListData, FactGroup, FactItem, FactValue, SplitData } from '../../types';
+import type { CompanyFactListData, FactGroup, FactItem, FactValue, SplitData } from '../../types';
 /**
  * Splits can be filed multiple times throughout different reports. There is no clear
  * indication on when the split is executed or what facts the split has been applied to. This

package/build/services/ReportRawBuilder/ReportRawBuilder.d.ts

@@ -1,6 +1,6 @@
-import { CompanyFactListData, FactGroup, FactItem, ReportRaw, SplitData } from '../../types';
+import type { CompanyFactListData, FactGroup, FactItem, ReportRaw, SplitData } from '../../types';
 import FactFiscalCalculator, { SetReportDatesParams } from './FactFiscalCalculator';
-interface BuildReportsParams {
+export interface BuildReportsParams {
     facts: FactItem[];
     /**
      * for more accurate dates, add this. Otherwise, dates will be inferred
@@ -37,4 +37,3 @@ export default class ReportRawBuilder {
         cik: number;
     }): ReportRaw[];
 }
-export {};

package/build/services/SecEdgarApi/FilingMapper.d.ts

@@ -1,4 +1,4 @@
-import { FilingListDetails, FilingListItemTranslated } from '../../types';
+import type { FilingListDetails, FilingListItemTranslated } from '../../types';
 export default class FilingMapper {
     mapFilingListDetails(cik: string | number, filingListDetails: FilingListDetails): FilingListItemTranslated[];
 }

package/build/services/SecEdgarApi/RequestWrapper.d.ts

@@ -1,4 +1,4 @@
-import { FilingListItemTranslated } from '../../types/submission.type';
+import type { FilingListItemTranslated } from '../../types/submission.type';
 export interface SubmissionRequestWrapperOptions {
     maxRequests?: number;
 }

package/build/services/SecEdgarApi/SecEdgarApi.d.ts

@@ -1,5 +1,4 @@
-import { CompanyFactFrame, CompanyFactListData, CompanyTickerItem, DailyFilingFormType, FieldDataResponse, Form10KData, Form13GData, Form4Data, FormDef14aData, MultiCompanyFactFrame, ReportRaw, ReportTranslated } from '../../types';
-import { FilingListDetails, FilingListItemTranslated, SubmissionList } from '../../types/submission.type';
+import type { CompanyFactFrame, CompanyFactListData, CompanyTickerItem, DailyFilingFormType, FieldDataResponse, Form10KData, Form13GData, Form4Data, FormDef14aData, MultiCompanyFactFrame, ReportRaw, ReportTranslated, FilingListDetails, FilingListItemTranslated, SubmissionList, CalculationMap } from '../../types';
 import { IClient } from '../Client';
 import DocumentParser from '../DocumentParser';
 import ReportParser from '../ReportParser';
@@ -169,8 +168,26 @@ export default class SecEdgarApi {
      * Parses reports from company facts. Calculates missing properties and uses a single interface
      * for all reports. This includes only 10-K and 10-Q annual and quarterly reports. To include
      * all reports, use getReportsRaw.
+     *
+     * @deprecated Formerly getReports. This will be removed in a future version.
      */
-    getReports<T extends GetReportsParams>(params: T): Promise<T['withWrapper'] extends true ? ReportWrapper[] : ReportTranslated[]>;
+    getReportsLegacy<T extends GetReportsParams>(params: T): Promise<T['withWrapper'] extends true ? ReportWrapper[] : ReportTranslated[]>;
+    /**
+     * Note: Properties that are not provied from report are calculated an may not be accurate,
+     * verify results finance.yahoo.com (ex: https://finance.yahoo.com/quote/AAPL/financials)
+     *
+     * Please contribute to improve resolving report properties: https://github.com/andyevers/sec-edgar-api
+     *
+     * Parses reports from company facts. Calculates missing properties and uses a single interface
+     * for all reports. This includes only 10-K and 10-Q annual and quarterly reports. To include
+     * all reports, use getReportsRaw.
+     */
+    getReports<R = ReportTranslated>(params: {
+        symbol: string | number;
+        adjustForSplits?: boolean;
+        resolvePeriodValues?: boolean;
+        calculationMap?: CalculationMap<R>;
+    }): Promise<(typeof params.calculationMap extends undefined ? ReportTranslated : ReportRaw & R)[]>;
     /**
      * Parses reports from company facts.
      */
@@ -216,7 +233,7 @@ export default class SecEdgarApi {
      */
     getDocumentXbrl(params: GetDocumentXbrlParams): Promise<import("../DocumentParser/XBRLParser/XBRLParser").XbrlParseResult & {
         report: ReportRaw | null;
-        facts: import("../../types").FactItem[];
+        facts: import("../../types").FactItemExtended[];
         xml: string;
     }>;
     /**
@@ -319,6 +336,8 @@ export default class SecEdgarApi {
     }>;
     /**
      * Search for companies from by name, sic code, or state.
+     *
+     * example at https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&owner=exclude&&start=0&count=100&hidefilings=0&company=Apple&match=contains
      */
     searchCompanies(params: SearchCompaniesParams): Promise<{
         items: import("../../types").CompanySearchResult[];

package/build/services/SecEdgarApi/SecEdgarApi.js

@@ -270,8 +270,10 @@ var SecEdgarApi = /** @class */ (function () {
      * Parses reports from company facts. Calculates missing properties and uses a single interface
      * for all reports. This includes only 10-K and 10-Q annual and quarterly reports. To include
      * all reports, use getReportsRaw.
+     *
+     * @deprecated Formerly getReports. This will be removed in a future version.
      */
-    SecEdgarApi.prototype.getReports = function (params) {
+    SecEdgarApi.prototype.getReportsLegacy = function (params) {
         return __awaiter(this, void 0, void 0, function () {
             var _a, withWrapper, _b, usePropertyResolver, reportsRaw, reportsWithWrapper, reports;
             return __generator(this, function (_c) {
@@ -281,13 +283,41 @@ var SecEdgarApi = /** @class */ (function () {
                         return [4 /*yield*/, this.getReportsRaw(__assign(__assign({}, params), { includeNamePrefix: false }))];
                     case 1:
                         reportsRaw = _c.sent();
-                        reportsWithWrapper = this.reportParser.parseReportsFromRaw({ reportsRaw: reportsRaw, usePropertyResolver: usePropertyResolver });
+                        reportsWithWrapper = this.reportParser.parseReportsFromRawLegacy({ reportsRaw: reportsRaw, usePropertyResolver: usePropertyResolver });
                         reports = withWrapper ? reportsWithWrapper : reportsWithWrapper.map(function (report) { return report.getReport(); });
                         return [2 /*return*/, reports];
                 }
             });
         });
     };
+    /**
+     * Note: Properties that are not provied from report are calculated an may not be accurate,
+     * verify results finance.yahoo.com (ex: https://finance.yahoo.com/quote/AAPL/financials)
+     *
+     * Please contribute to improve resolving report properties: https://github.com/andyevers/sec-edgar-api
+     *
+     * Parses reports from company facts. Calculates missing properties and uses a single interface
+     * for all reports. This includes only 10-K and 10-Q annual and quarterly reports. To include
+     * all reports, use getReportsRaw.
+     */
+    SecEdgarApi.prototype.getReports = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var calculationMap, reportsRaw;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        calculationMap = params.calculationMap;
+                        return [4 /*yield*/, this.getReportsRaw(__assign(__assign({}, params), { includeNamePrefix: true }))];
+                    case 1:
+                        reportsRaw = _a.sent();
+                        return [2 /*return*/, this.reportParser.parseReportsFromRaw({
+                                reportsRaw: reportsRaw,
+                                calculationMap: calculationMap,
+                            })];
+                }
+            });
+        });
+    };
     /**
      * Parses reports from company facts.
      */
@@ -671,6 +701,8 @@ var SecEdgarApi = /** @class */ (function () {
     };
     /**
      * Search for companies from by name, sic code, or state.
+     *
+     * example at https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&owner=exclude&&start=0&count=100&hidefilings=0&company=Apple&match=contains
      */
     SecEdgarApi.prototype.searchCompanies = function (params) {
         return __awaiter(this, void 0, void 0, function () {

package/build/types/calculation-map.type.d.ts

@@ -0,0 +1,13 @@
+export type CalculationMap<T = any> = Record<keyof T, CalculationMapItem>;
+export interface CalculationMapCalculationItem {
+    key: string;
+    weight: number;
+    isRequired: boolean;
+}
+export interface CalculationMapCalculation {
+    calculation: CalculationMapCalculationItem[];
+}
+export interface CalculationMapItem {
+    groups: CalculationMapCalculation[];
+}
+export type CalculationMapCondensed<T = object> = Record<keyof T, (string | number)[][][]>;

package/build/types/calculation-map.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,4 +1,4 @@
-import { FactItem } from './company-facts.type';
+import type { FactItem } from './company-facts.type';
 export interface XMLParams {
     xml: string;
 }
@@ -42,12 +42,3 @@ export interface FactGroup {
     valueTrailingFirst: number | string | null;
     valueTrailingLast: number | string | null;
 }
-export interface FactItemExtended extends FactItem {
-    period: number;
-    year: number;
-    quarter: number;
-    periodValue: number | null;
-    trailingValue: number | null;
-    splitValue: number | null;
-    splitsApplied: number[];
-}

package/build/types/company-facts.type.d.ts

@@ -1,4 +1,4 @@
-import { FiscalPeriod } from './report-raw.type';
+import type { FiscalPeriod } from './report-raw.type';
 export interface CompanyFactListData {
     cik: number;
     entityName: string;
@@ -74,6 +74,11 @@ export interface FactItem {
     }[];
     uuid?: string;
 }
+export interface FactItemExtended extends FactItem {
+    isUsedInReport?: boolean;
+    decimals?: number;
+    scale?: number;
+}
 export interface FactItemWithFiscals extends FactItem {
     fiscalPeriod: FiscalPeriod;
     year: number;

package/build/types/company-search.type.d.ts

@@ -1,5 +1,7 @@
 export interface CompanySearchResult {
     cik: number;
+    sic: number | null;
+    sicDescription: string | null;
     companyName: string;
-    stateOrCountry: string;
+    stateOrCountry: string | null;
 }

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

@@ -11,6 +11,7 @@ export interface FilingItemXBRL {
     title: string;
     link: string;
     guid: string;
+    url: string;
     enclosureUrl: string;
     enclosureLength: number;
     enclosureType: string;

package/build/types/index.d.ts

@@ -1,9 +1,11 @@
-export * from './company-facts.type';
-export * from './report-raw.type';
-export * from './report-translated.type';
-export * from './submission.type';
-export * from './parsed-filings.type';
-export * from './common.type';
-export * from './insider-transaction.type';
-export * from './company-search.type';
-export * from './current-filings.type';
+export type * from './company-facts.type';
+export type * from './report-raw.type';
+export type * from './report-translated.type';
+export type * from './submission.type';
+export type * from './parsed-filings.type';
+export type * from './common.type';
+export type * from './insider-transaction.type';
+export type * from './company-search.type';
+export type * from './current-filings.type';
+export type * from './xbrl.type';
+export type * from './calculation-map.type';

package/build/types/index.js

@@ -1,25 +1,2 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./company-facts.type"), exports);
-__exportStar(require("./report-raw.type"), exports);
-__exportStar(require("./report-translated.type"), exports);
-__exportStar(require("./submission.type"), exports);
-__exportStar(require("./parsed-filings.type"), exports);
-__exportStar(require("./common.type"), exports);
-__exportStar(require("./insider-transaction.type"), exports);
-__exportStar(require("./company-search.type"), exports);
-__exportStar(require("./current-filings.type"), exports);

package/build/types/insider-transaction.type.d.ts

@@ -1,3 +1,4 @@
+export type TransactionCode = 'S' | 'V' | 'A' | 'D' | 'F' | 'I' | 'M' | 'C' | 'E' | 'H' | 'O' | 'X' | 'G' | 'L' | 'W' | 'Z' | 'J' | 'K' | 'U';
 export interface Owner {
     ownerName: string;
     ownerCik: number;
@@ -22,7 +23,29 @@ export interface InsiderTransaction {
     isDirectOwnership: boolean;
     securityTitle: string;
     transactionDate: string;
-    transactionCode: string;
+    /**
+     * ### Transaction Codes
+     * - 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
+     */
+    transactionCode: TransactionCode;
     transactionShares: number;
     sharesOwnedFollowingTransaction: number;
     lineNumber: number;
@@ -30,3 +53,26 @@ export interface InsiderTransaction {
     form: string;
     accessionNumber: string;
 }
+export type TransactionType = 'Acquire' | 'Dispose';
+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>>;
+}