sec-edgar-api 0.3.3 → 0.4.0

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

@@ -0,0 +1,155 @@
+export interface XbrlContext {
+    id: string;
+    entity: {
+        identifier: {
+            value: string;
+            scheme: string;
+        };
+        segment: {
+            value: string;
+            dimension: string;
+        }[];
+    };
+    period: {
+        startDate?: string;
+        endDate?: string;
+        instant?: string;
+    };
+}
+export interface XbrlUnit {
+    id: string;
+    measure: string;
+}
+export interface XbrlElement {
+    id: string;
+    name: string;
+    contextRef: string;
+    continuedAt?: string;
+    decimals?: string;
+    escape?: string;
+    format?: string;
+    order?: string;
+    precision?: string;
+    scale?: string;
+    sign?: string;
+    target?: string;
+    text?: string;
+    tupleID?: string;
+    tupleRef?: string;
+    unitRef?: string;
+}
+export interface XbrlInstance {
+    contexts: XbrlContext[];
+    units: XbrlUnit[];
+    factElements: XbrlElement[];
+}
+export interface XbrlSchema {
+    annotation?: XbrlSchemaAnnotation;
+    import?: XbrlSchemaImport[];
+    element?: XbrlSchemaElement[];
+    targetNamespace?: string;
+    elementFormDefault?: string;
+    attributeFormDefault?: string;
+    xmlns?: string;
+    _xmlnsProps: Record<string, string>;
+}
+export interface XbrlLinkbaseRoleType {
+    id: string;
+    definition: string;
+    usedOn: string[];
+    roleURI: string;
+}
+export interface XbrlLinkbaseItemExtended {
+    type: 'extended';
+    id?: string;
+    role?: string;
+    loc?: XbrlLinkbaseItemLocator[];
+    calculationArc?: XbrlLinkbaseItemArc[];
+    definitionArc?: XbrlLinkbaseItemArc[];
+    labelArc?: XbrlLinkbaseItemArc[];
+    presentationArc?: XbrlLinkbaseItemArc[];
+    footnoteArc?: XbrlLinkbaseItemArc[];
+    label?: XbrlLinkbaseItemResource[];
+    footnote?: XbrlLinkbaseItemResource[];
+}
+export interface XbrlLinkbaseItemSimple {
+    type: 'simple';
+    href?: string;
+    xlink?: string;
+    arcrole?: string;
+    role?: string;
+    title?: string;
+    roleURI?: string;
+    arcroleURI?: string;
+}
+export interface XbrlLinkbaseItemLocator {
+    type: 'locator';
+    label: string;
+    href: string;
+}
+export interface XbrlLinkbaseItemArc {
+    type: 'arc';
+    from: string;
+    to: string;
+    order?: number;
+    weight?: number;
+    arcrole?: string;
+    priority?: number;
+    closed?: boolean;
+    contextElement?: string;
+    preferredLabel?: string;
+}
+export interface XbrlLinkbaseItemResource {
+    type: 'resource';
+    id?: string;
+    text?: string;
+    label?: string;
+    role?: string;
+    xml?: string;
+    lang?: string;
+}
+export interface XML {
+    version?: string;
+    encoding?: string;
+}
+export interface XbrlLinkbase {
+    roleRef?: XbrlLinkbaseItemSimple[];
+    arcroleRef?: XbrlLinkbaseItemSimple[];
+    referenceLink?: XbrlLinkbaseItemExtended[];
+    labelLink?: XbrlLinkbaseItemExtended[];
+    presentationLink?: XbrlLinkbaseItemExtended[];
+    calculationLink?: XbrlLinkbaseItemExtended[];
+    definitionLink?: XbrlLinkbaseItemExtended[];
+    xmlns?: string;
+    xsi?: string;
+    xlink?: string;
+    schemaLocation?: string;
+}
+export interface XbrlSchemaAnnotation {
+    appinfo: XbrlSchemaAppinfo;
+    documentation?: string;
+}
+export interface XbrlSchemaAppinfo {
+    roleType: XbrlLinkbaseRoleType[];
+    linkbaseRef: XbrlLinkbaseItemSimple[];
+}
+export interface XbrlSchemaElement {
+    name: string;
+    id: string;
+    type: string;
+    abstract?: boolean;
+    periodType?: 'instant' | 'duration';
+    nillable?: boolean;
+    substitutionGroup?: string;
+    balance?: string;
+    typedDomainRef?: string;
+    domain?: string;
+    headUsable?: boolean;
+    linkrole?: string;
+    complexType?: object;
+    annotation?: object;
+}
+export interface XbrlSchemaImport {
+    namespace: string;
+    schemaLocation: string;
+}

package/build/types/xbrl.type.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "sec-edgar-api",
-    "version": "0.3.3",
+    "version": "0.4.0",
     "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)",
@@ -13,7 +13,8 @@
     "scripts": {
         "test": "jest test",
         "build": "tsc",
-        "publish": "npm run build && npm publish"
+        "publish": "npm run build && npm publish",
+        "lint": "npx eslint src"
     },
     "keywords": [
         "sec",
@@ -26,11 +27,15 @@
         "reports"
     ],
     "devDependencies": {
+        "@eslint/js": "^9.11.1",
+        "@types/eslint__js": "^8.42.3",
         "@types/jest": "^29.5.2",
+        "eslint": "^9.11.1",
         "jest": "^29.5.0",
         "prettier": "^2.8.8",
         "ts-jest": "^29.1.0",
-        "typescript": "^5.1.3"
+        "typescript": "5.1.3",
+        "typescript-eslint": "^8.8.0"
     },
     "files": [
         "build/**/*"