sec-edgar-api 0.0.1

package/build/services/SecEdgarApi/Unzipper.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var fs = require("fs");
+var _unzipper = require("unzipper");
+var Unzipper = /** @class */ (function () {
+    function Unzipper(args) {
+        if (args === void 0) { args = { fileManager: fs, unzipper: _unzipper }; }
+        var fileManager = args.fileManager, unzipper = args.unzipper;
+        this.fileManager = fileManager;
+        this.unzipper = unzipper;
+    }
+    Unzipper.prototype.unzip = function (params) {
+        var _this = this;
+        var inputFilename = params.inputFilename, outputDirname = params.outputDirname, onChunk = params.onChunk, onError = params.onError, _a = params.deleteOriginal, deleteOriginal = _a === void 0 ? false : _a;
+        return new Promise(function (resolve, reject) {
+            var file = _this.fileManager.createReadStream(inputFilename);
+            var filesize = _this.fileManager.statSync(inputFilename).size;
+            var unzipped = _this.unzipper.Extract({ path: outputDirname });
+            var lengthCurrent = 0;
+            file.on('data', function (chunk) {
+                lengthCurrent += chunk.length;
+                var percentComplete = lengthCurrent / filesize;
+                onChunk === null || onChunk === void 0 ? void 0 : onChunk({ percentComplete: percentComplete, chunk: chunk });
+            });
+            file.pipe(unzipped);
+            file.on('end', function () {
+                if (deleteOriginal) {
+                    _this.fileManager.unlinkSync(inputFilename);
+                }
+                resolve(true);
+            });
+            file.on('error', function (err) {
+                onError === null || onError === void 0 ? void 0 : onError(err);
+                reject(false);
+            });
+        });
+    };
+    return Unzipper;
+}());
+exports.default = Unzipper;

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

@@ -0,0 +1,3 @@
+import SecEdgarApi from './SecEdgarApi';
+export default SecEdgarApi;
+export * from './SecEdgarApi';

package/build/services/SecEdgarApi/index.js

@@ -0,0 +1,19 @@
+"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 });
+var SecEdgarApi_1 = require("./SecEdgarApi");
+exports.default = SecEdgarApi_1.default;
+__exportStar(require("./SecEdgarApi"), exports);

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

@@ -0,0 +1,53 @@
+export interface CompanyFactListData {
+    cik: number;
+    entityName: string;
+    facts: CompanyFactList;
+}
+export interface CompanyFactList {
+    dei: Record<string, CompanyFact>;
+    invest?: Record<string, CompanyFact>;
+    'us-gaap'?: Record<string, CompanyFact>;
+}
+export interface CompanyFact {
+    label: string;
+    description: string;
+    units: Record<string, FactValue[]>;
+}
+export interface FactValue {
+    start?: string;
+    end: string;
+    val: number;
+    accn: string;
+    fy?: number;
+    fp: string;
+    form: string;
+    filed: string;
+    frame?: string;
+}
+export interface CompanyFactFrame {
+    cik: number;
+    taxonomy: string;
+    tag: string;
+    label: string;
+    description: string;
+    entityName: string;
+    units: Record<string, FactValue[]>;
+}
+export interface MultiCompanyFactFrameItem {
+    accn: string;
+    cik: number;
+    entityName: string;
+    loc: string;
+    end: string;
+    val: number;
+}
+export interface MultiCompanyFactFrame {
+    taxonomy: string;
+    tag: string;
+    ccp: string;
+    uom: string;
+    label: string;
+    description: string;
+    pts: number;
+    data: MultiCompanyFactFrameItem[];
+}

package/build/types/company-facts.type.js

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

package/build/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from './company-facts.type';
+export * from './report-raw.type';
+export * from './report-translated.type';
+export * from './submission.type';

package/build/types/index.js

@@ -0,0 +1,20 @@
+"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);

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

@@ -0,0 +1,23 @@
+/**
+ * Contains all keys matched from the report, along with the added keys dateEnd, dateFiled, fiscalPeriod, fiscalYear.
+ */
+export type ReportRaw = {
+    [key: string]: string | number | boolean;
+    dateReport: string;
+    dateFiled: string;
+    form: string;
+    isTTM: boolean;
+    frame: string;
+    taxonomy: string;
+    reportType: ReportType;
+    fiscalPeriod: FiscalPeriod;
+    fiscalYear: number;
+};
+/**
+ * QUARTERLY = 10-Q and 10-K forms for the quarter | ANNUAL = 10-K forms for the year |
+ * 8K = all 8K form types | DOCUMENT_ENTITY_INFO = reports under key dei
+ *
+ * for dei, see https://www.sec.gov/structureddata/announcement/osd-announcement-2212-new-2022q4-taxonomies
+ */
+export type ReportType = 'QUARTERLY' | 'ANNUAL' | '8K' | 'DOCUMENT_ENTITY_INFO';
+export type FiscalPeriod = 'Q1' | 'Q2' | 'Q3' | 'Q4' | 'FY';

package/build/types/report-raw.type.js

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

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

@@ -0,0 +1,58 @@
+import { FiscalPeriod } from './report-raw.type';
+export interface ReportTranslated {
+    dateReport: string;
+    dateFiled: string;
+    fiscalPeriod: FiscalPeriod;
+    fiscalYear: number;
+    form: string;
+    isTTM: boolean;
+    assetTotal: number | null;
+    assetCurrent: number | null;
+    assetCurrentCashEquivalents: number | null;
+    assetCurrentInvestments: number | null;
+    assetCurrentAccountsReceivable: number | null;
+    assetCurrentInventory: number | null;
+    assetNonCurrent: number | null;
+    assetNonCurrentPPENet: number | null;
+    assetNonCurrentPPEGross: number | null;
+    assetNonCurrentInvestments: number | null;
+    assetNonCurrentGoodwill: number | null;
+    assetNonCurrentIntangibleLessGoodwill: number | null;
+    liabilityTotal: number | null;
+    liabilityCurrent: number | null;
+    liabilityCurrentAccountsPayable: number | null;
+    liabilityCurrentDebt: number | null;
+    liabilityNonCurrent: number | null;
+    liabilityNonCurrentDebt: number | null;
+    equityTotal: number | null;
+    equityRetainedEarnings: number | null;
+    equityStockPreferred: number | null;
+    sharesOutstanding: number | null;
+    sharesOutstandingDiluted: number | null;
+    eps: number | null;
+    epsDiluted: number | null;
+    ebit: number | null;
+    ebitda: number | null;
+    profitGross: number | null;
+    revenueTotal: number | null;
+    revenueCost: number | null;
+    revenueOperating: number | null;
+    expenseTotal: number | null;
+    expenseOperating: number | null;
+    expenseResearchDevelopment: number | null;
+    expenseInterest: number | null;
+    expenseDepreciation: number | null;
+    expenseTax: number | null;
+    expenseDepreciationAccumulated: number | null;
+    expenseStockCompensation: number | null;
+    expenseNonCashOther: number | null;
+    incomeOperating: number | null;
+    incomeNet: number | null;
+    cashFlowFree: number | null;
+    cashFlowDividendsPaid: number | null;
+    cashFlowDividendsPaidPreferred: number | null;
+    cashFlowCapex: number | null;
+    cashFlowOperating: number | null;
+    cashFlowDeferredTax: number | null;
+    cashFlowWorkingCapitalNonCash: number | null;
+}

package/build/types/report-translated.type.js

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

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

@@ -0,0 +1,70 @@
+interface Address {
+    street1: string;
+    street2: string | null;
+    city: string;
+    stateOrCountry: string;
+    zipCode: string;
+    stateOrCountryDescription: string;
+}
+interface AddressList {
+    mailing: Address;
+    business: Address;
+}
+interface FormerNameData {
+    name: string;
+    from: string;
+    to: string;
+}
+interface FileData {
+    name: string;
+    filingCount: number;
+    filingFrom: string;
+    filingTo: string;
+}
+interface FilingListDetails {
+    accessionNumber: string[];
+    filingDate: string[];
+    reportDate: string[];
+    acceptanceDateTime: string[];
+    act: string[];
+    form: string[];
+    fileNumber: string[];
+    filmNumber: string[];
+    items: string[];
+    size: number[];
+    isXBRL: number[];
+    isInlineXBRL: number[];
+    primaryDocument: string[];
+    primaryDocDescription: string[];
+}
+interface FilingList {
+    recent: FilingListDetails;
+    files: FileData[];
+}
+export interface SubmissionList {
+    cik: number;
+    entityType: string;
+    sic: string;
+    sicDescription: string;
+    /** 1 or 0 */
+    insiderTransactionForOwnerExists: number;
+    /** 1 or 0 */
+    insiderTransactionForIssuerExists: number;
+    name: string;
+    tickers: string[];
+    exchanges: string[];
+    ein: string;
+    description: string;
+    website: string;
+    investorWebsite: string;
+    category: string;
+    fiscalYearEnd: string;
+    stateOfIncorporation: string;
+    stateOfIncorporationDescription: string;
+    addresses: AddressList;
+    phone: string;
+    flags: string;
+    formerNames: FormerNameData[];
+    filings: FilingList;
+}
+export {};

package/build/types/submission.type.js

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

package/build/util/cik-by-symbol.d.ts

@@ -0,0 +1,5 @@
+/**
+ * CIK number by symbol from SEC website
+ */
+declare const cikBySymbol: Record<string, number>;
+export default cikBySymbol;