sec-edgar-api 1.0.1 → 1.0.2

package/build/services/DocumentParser/XBRLParser/XBRLParser.js

@@ -14,19 +14,20 @@ var XBRLParser = /** @class */ (function () {
         this.schemaParser = new SchemaParser_1.default();
     }
     XBRLParser.prototype.filterDocuments = function (documents) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         var xmlDocs = documents.filter(function (doc) { return doc.fileName.endsWith('.xml') || doc.fileName.endsWith('.xsd'); });
+        var instanceDoc = (_a = xmlDocs.find(function (doc) {
+            return doc.description.toLowerCase().includes('instance doc') ||
+                doc.fileName.endsWith('_htm.xml') ||
+                (doc.content.includes('<us-gaap') && doc.content.includes('<context'));
+        })) !== null && _a !== void 0 ? _a : null;
         return {
-            instanceDoc: (_a = xmlDocs.find(function (doc) {
-                return doc.description.toLowerCase().includes('instance doc') ||
-                    doc.fileName.endsWith('_htm.xml') ||
-                    (doc.content.includes('<us-gaap') && doc.content.includes('<context'));
-            })) !== null && _a !== void 0 ? _a : null,
+            instanceDoc: instanceDoc,
             schemaDoc: (_b = xmlDocs.find(function (doc) { return doc.fileName.endsWith('.xsd'); })) !== null && _b !== void 0 ? _b : null,
-            linkbasePresentationDoc: (_c = xmlDocs.find(function (doc) { return doc.fileName.endsWith('_pre.xml'); })) !== null && _c !== void 0 ? _c : null,
-            linkbaseDefinitionDoc: (_d = xmlDocs.find(function (doc) { return doc.fileName.endsWith('_def.xml'); })) !== null && _d !== void 0 ? _d : null,
-            linkbaseCalculationDoc: (_e = xmlDocs.find(function (doc) { return doc.fileName.endsWith('_cal.xml'); })) !== null && _e !== void 0 ? _e : null,
-            linkbaseLabelDoc: (_f = xmlDocs.find(function (doc) { return doc.fileName.endsWith('_lab.xml'); })) !== null && _f !== void 0 ? _f : null,
+            linkbasePresentationDoc: (_d = (_c = xmlDocs.find(function (doc) { return doc.fileName.endsWith('_pre.xml'); })) !== null && _c !== void 0 ? _c : xmlDocs.find(function (doc) { return doc !== instanceDoc && doc.content.includes('link:presentationLink>'); })) !== null && _d !== void 0 ? _d : null,
+            linkbaseDefinitionDoc: (_f = (_e = xmlDocs.find(function (doc) { return doc.fileName.endsWith('_def.xml'); })) !== null && _e !== void 0 ? _e : xmlDocs.find(function (doc) { return doc !== instanceDoc && doc.content.includes('link:definitionLink>'); })) !== null && _f !== void 0 ? _f : null,
+            linkbaseCalculationDoc: (_h = (_g = xmlDocs.find(function (doc) { return doc.fileName.endsWith('_cal.xml'); })) !== null && _g !== void 0 ? _g : xmlDocs.find(function (doc) { return doc !== instanceDoc && doc.content.includes('link:calculationLink>'); })) !== null && _h !== void 0 ? _h : null,
+            linkbaseLabelDoc: (_k = (_j = xmlDocs.find(function (doc) { return doc.fileName.endsWith('_lab.xml'); })) !== null && _j !== void 0 ? _j : xmlDocs.find(function (doc) { return doc !== instanceDoc && doc.content.includes('link:labelLink>'); })) !== null && _k !== void 0 ? _k : null,
         };
     };
     XBRLParser.prototype.createXbrlDocument = function (doc, xbrl) {

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

@@ -1,3 +1,6 @@
 import { XbrlLinkbase } from '../types/xbrl.type';
+/**
+ * Gets labels by taxonomy from the label linkbase. priority level: verboseLabel > terseLabel > label.
+ */
 export declare function getLabelByTaxonomy(labelLinkbase: XbrlLinkbase): Record<string, string>;
 export declare function getTaxonomyFromId(id: string): string;

package/build/util/util-xbrl.js

@@ -1,16 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTaxonomyFromId = exports.getLabelByTaxonomy = void 0;
+/**
+ * Gets labels by taxonomy from the label linkbase. priority level: verboseLabel > terseLabel > label.
+ */
 function getLabelByTaxonomy(labelLinkbase) {
     var _a;
     var labelByTaxonomy = {};
+    var taxonomyWithVerboseLabels = new Set();
     (_a = labelLinkbase.labelLink) === null || _a === void 0 ? void 0 : _a.forEach(function (link) {
         var _a;
         (_a = link.label) === null || _a === void 0 ? void 0 : _a.forEach(function (_a) {
             var _b = _a.label, label = _b === void 0 ? '' : _b, _c = _a.text, text = _c === void 0 ? '' : _c, _d = _a.role, role = _d === void 0 ? '' : _d;
             var taxonomy = getTaxonomyFromId(label);
+            // skip if verbose label already exists for this taxonomy
+            if (taxonomyWithVerboseLabels.has(taxonomy)) {
+                return;
+            }
+            // label, terseLabel, or verboseLabel
+            var labelType = role.substring(role.lastIndexOf('/') + 1);
+            if (labelType === 'verboseLabel') {
+                taxonomyWithVerboseLabels.add(taxonomy);
+            }
             // prefer terseLabel over regular label
-            if (role.endsWith('terseLabel') || !labelByTaxonomy[taxonomy]) {
+            if (!labelByTaxonomy[taxonomy] || labelType === 'terseLabel' || labelType === 'verboseLabel') {
                 labelByTaxonomy[taxonomy] = text;
             }
         });

package/package.json

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

package/build/examples/xbrl-practical-examples.d.ts

@@ -1,97 +0,0 @@
-/**
- * Practical examples of working with XBRL relationships using your existing types
- */
-import type { XbrlInstance, XbrlLinkbase } from '../types';
-/**
- * Example 1: Extract presentation hierarchy from your XBRL data
- */
-export declare function extractPresentationHierarchy(presentationLinkbase: XbrlLinkbase): Record<string, ConceptNode>;
-/**
- * Example 2: Extract calculation relationships
- */
-export declare function extractCalculationRelationships(calculationLinkbase: XbrlLinkbase): Record<string, CalculationRule>;
-/**
- * Example 3: Extract dimensional relationships (axis/member mappings)
- */
-export declare function extractDimensionalRelationships(definitionLinkbase: XbrlLinkbase): Record<string, DimensionStructure>;
-/**
- * Example 4: Find facts with specific dimensional context
- */
-export declare function findFactsWithDimensions(instance: XbrlInstance, conceptName: string, dimensionFilters?: {
-    dimension: string;
-    member?: string;
-}[]): {
-    fact: import("../types").XbrlElement;
-    context: import("../types").XbrlContext;
-    dimensions: {
-        dimension: string;
-        member: string;
-    }[];
-}[];
-/**
- * Example 5: Build a complete concept map with all relationships
- */
-export declare function buildCompleteConceptMap(linkbases: {
-    presentation: XbrlLinkbase;
-    calculation: XbrlLinkbase;
-    definition: XbrlLinkbase;
-    label: XbrlLinkbase;
-}): Map<string, CompleteConcept>;
-interface ConceptNode {
-    concept: string;
-    children: ConceptChild[];
-    role: string;
-    order: number;
-}
-interface ConceptChild {
-    concept: string;
-    order: number;
-    preferredLabel?: string;
-}
-interface CalculationRule {
-    summationItem: string;
-    contributingItems: CalculationItem[];
-}
-interface CalculationItem {
-    concept: string;
-    weight: number;
-    order: number;
-}
-interface DimensionStructure {
-    concept: string;
-    type: string;
-    dimensions?: string[];
-    domains?: string[];
-    members?: string[];
-}
-interface ConceptLabel {
-    text: string;
-    role: string;
-    lang: string;
-}
-interface CompleteConcept {
-    name: string;
-    labels: ConceptLabel[];
-    presentation: ConceptNode | null;
-    calculation: CalculationRule | null;
-    dimensions: DimensionStructure | null;
-}
-export declare function usageExamples(): {
-    segmentRevenue: {
-        fact: import("../types").XbrlElement;
-        context: import("../types").XbrlContext;
-        dimensions: {
-            dimension: string;
-            member: string;
-        }[];
-    }[];
-    northAmericaRevenue: {
-        fact: import("../types").XbrlElement;
-        context: import("../types").XbrlContext;
-        dimensions: {
-            dimension: string;
-            member: string;
-        }[];
-    }[];
-};
-export {};

package/build/examples/xbrl-practical-examples.js

@@ -1,277 +0,0 @@
-"use strict";
-/**
- * Practical examples of working with XBRL relationships using your existing types
- */
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.usageExamples = exports.buildCompleteConceptMap = exports.findFactsWithDimensions = exports.extractDimensionalRelationships = exports.extractCalculationRelationships = exports.extractPresentationHierarchy = void 0;
-/**
- * Example 1: Extract presentation hierarchy from your XBRL data
- */
-function extractPresentationHierarchy(presentationLinkbase) {
-    var _a;
-    var hierarchy = {};
-    // Process each presentation link (usually one per role/statement)
-    (_a = presentationLinkbase.presentationLink) === null || _a === void 0 ? void 0 : _a.forEach(function (link) {
-        var roleUri = link.role || 'default';
-        // Get all concept locators and relationship arcs
-        var locators = (link.loc || []);
-        var arcs = (link.presentationArc || []);
-        // Build concept reference map
-        var conceptMap = new Map();
-        locators.forEach(function (loc) {
-            var concept = extractConceptFromHref(loc.href);
-            conceptMap.set(loc.label, concept);
-        });
-        // Build parent-child relationships
-        arcs.forEach(function (arc) {
-            var parent = conceptMap.get(arc.from);
-            var child = conceptMap.get(arc.to);
-            if (parent && child) {
-                // Initialize parent node if it doesn't exist
-                if (!hierarchy[parent]) {
-                    hierarchy[parent] = {
-                        concept: parent,
-                        children: [],
-                        role: roleUri,
-                        order: 0,
-                    };
-                }
-                // Add child with ordering information
-                hierarchy[parent].children.push({
-                    concept: child,
-                    order: arc.order || 0,
-                    preferredLabel: arc.preferredLabel,
-                });
-                // Sort children by order
-                hierarchy[parent].children.sort(function (a, b) { return a.order - b.order; });
-            }
-        });
-    });
-    return hierarchy;
-}
-exports.extractPresentationHierarchy = extractPresentationHierarchy;
-/**
- * Example 2: Extract calculation relationships
- */
-function extractCalculationRelationships(calculationLinkbase) {
-    var _a;
-    var calculations = {};
-    (_a = calculationLinkbase.calculationLink) === null || _a === void 0 ? void 0 : _a.forEach(function (link) {
-        var locators = (link.loc || []);
-        var arcs = (link.calculationArc || []);
-        // Build concept reference map
-        var conceptMap = new Map();
-        locators.forEach(function (loc) {
-            var concept = extractConceptFromHref(loc.href);
-            conceptMap.set(loc.label, concept);
-        });
-        // Group arcs by summation item (the 'to' end of the arc)
-        var summationGroups = new Map();
-        arcs.forEach(function (arc) {
-            var summationConcept = conceptMap.get(arc.to);
-            if (summationConcept) {
-                if (!summationGroups.has(summationConcept)) {
-                    summationGroups.set(summationConcept, []);
-                }
-                summationGroups.get(summationConcept).push(arc);
-            }
-        });
-        // Build calculation rules
-        summationGroups.forEach(function (contributingArcs, summationConcept) {
-            calculations[summationConcept] = {
-                summationItem: summationConcept,
-                contributingItems: contributingArcs.map(function (arc) { return ({
-                    concept: conceptMap.get(arc.from) || '',
-                    weight: arc.weight || 1,
-                    order: arc.order || 0,
-                }); }),
-            };
-        });
-    });
-    return calculations;
-}
-exports.extractCalculationRelationships = extractCalculationRelationships;
-/**
- * Example 3: Extract dimensional relationships (axis/member mappings)
- */
-function extractDimensionalRelationships(definitionLinkbase) {
-    var _a;
-    var dimensions = {};
-    (_a = definitionLinkbase.definitionLink) === null || _a === void 0 ? void 0 : _a.forEach(function (link) {
-        var locators = (link.loc || []);
-        var arcs = (link.definitionArc || []);
-        // Build concept reference map
-        var conceptMap = new Map();
-        locators.forEach(function (loc) {
-            var concept = extractConceptFromHref(loc.href);
-            conceptMap.set(loc.label, concept);
-        });
-        // Process dimensional arcs based on their arcrole
-        arcs.forEach(function (arc) {
-            var fromConcept = conceptMap.get(arc.from);
-            var toConcept = conceptMap.get(arc.to);
-            var arcrole = arc.arcrole || '';
-            if (fromConcept && toConcept) {
-                switch (arcrole) {
-                    case 'http://xbrl.org/int/dim/arcrole/hypercube-dimension':
-                        // Hypercube contains dimension
-                        initializeDimension(dimensions, fromConcept, 'hypercube');
-                        dimensions[fromConcept].dimensions = dimensions[fromConcept].dimensions || [];
-                        dimensions[fromConcept].dimensions.push(toConcept);
-                        break;
-                    case 'http://xbrl.org/int/dim/arcrole/dimension-domain':
-                        // Dimension has domain
-                        initializeDimension(dimensions, fromConcept, 'dimension');
-                        dimensions[fromConcept].domains = dimensions[fromConcept].domains || [];
-                        dimensions[fromConcept].domains.push(toConcept);
-                        break;
-                    case 'http://xbrl.org/int/dim/arcrole/domain-member':
-                        // Domain has member
-                        initializeDimension(dimensions, fromConcept, 'domain');
-                        dimensions[fromConcept].members = dimensions[fromConcept].members || [];
-                        dimensions[fromConcept].members.push(toConcept);
-                        break;
-                }
-            }
-        });
-    });
-    return dimensions;
-}
-exports.extractDimensionalRelationships = extractDimensionalRelationships;
-/**
- * Example 4: Find facts with specific dimensional context
- */
-function findFactsWithDimensions(instance, conceptName, dimensionFilters) {
-    var matchingFacts = [];
-    // Filter facts by concept name
-    var conceptFacts = instance.factElements.filter(function (fact) { return fact.name === conceptName; });
-    var _loop_1 = function (fact) {
-        // Get the context for this fact
-        var context = instance.contexts.find(function (ctx) { return ctx.id === fact.contextRef; });
-        if (!context)
-            return "continue";
-        // Check if this fact matches our dimensional filters
-        if (dimensionFilters) {
-            var matchesFilters = dimensionFilters.every(function (filter) {
-                var matchingSegment = context.entity.segment.find(function (seg) { return seg.dimension === filter.dimension; });
-                if (!matchingSegment)
-                    return false;
-                // If specific member is required, check for it
-                if (filter.member && matchingSegment.value !== filter.member) {
-                    return false;
-                }
-                return true;
-            });
-            if (!matchesFilters)
-                return "continue";
-        }
-        matchingFacts.push({
-            fact: fact,
-            context: context,
-            dimensions: context.entity.segment.map(function (seg) { return ({
-                dimension: seg.dimension,
-                member: seg.value,
-            }); }),
-        });
-    };
-    for (var _i = 0, conceptFacts_1 = conceptFacts; _i < conceptFacts_1.length; _i++) {
-        var fact = conceptFacts_1[_i];
-        _loop_1(fact);
-    }
-    return matchingFacts;
-}
-exports.findFactsWithDimensions = findFactsWithDimensions;
-/**
- * Example 5: Build a complete concept map with all relationships
- */
-function buildCompleteConceptMap(linkbases) {
-    var conceptMap = new Map();
-    // Extract all relationships
-    var presentationHierarchy = extractPresentationHierarchy(linkbases.presentation);
-    var calculationRelationships = extractCalculationRelationships(linkbases.calculation);
-    var dimensionalRelationships = extractDimensionalRelationships(linkbases.definition);
-    var labels = extractLabels(linkbases.label);
-    // Combine all concepts
-    var allConcepts = new Set(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], Object.keys(presentationHierarchy), true), Object.keys(calculationRelationships), true), Object.keys(dimensionalRelationships), true), Object.keys(labels), true));
-    // Build complete concept entries
-    allConcepts.forEach(function (concept) {
-        conceptMap.set(concept, {
-            name: concept,
-            labels: labels[concept] || [],
-            presentation: presentationHierarchy[concept] || null,
-            calculation: calculationRelationships[concept] || null,
-            dimensions: dimensionalRelationships[concept] || null,
-        });
-    });
-    return conceptMap;
-}
-exports.buildCompleteConceptMap = buildCompleteConceptMap;
-// Helper functions and types
-function extractConceptFromHref(href) {
-    var match = href.match(/#(.+)$/);
-    return match ? match[1] : '';
-}
-function initializeDimension(dimensions, concept, type) {
-    if (!dimensions[concept]) {
-        dimensions[concept] = {
-            concept: concept,
-            type: type,
-            dimensions: [],
-            domains: [],
-            members: [],
-        };
-    }
-}
-function extractLabels(labelLinkbase) {
-    var _a;
-    var labels = {};
-    (_a = labelLinkbase.labelLink) === null || _a === void 0 ? void 0 : _a.forEach(function (link) {
-        var locators = (link.loc || []);
-        var arcs = (link.labelArc || []);
-        var labelResources = link.label || [];
-        // Build concept reference map
-        var conceptMap = new Map();
-        locators.forEach(function (loc) {
-            var concept = extractConceptFromHref(loc.href);
-            conceptMap.set(loc.label, concept);
-        });
-        // Connect labels to concepts
-        arcs.forEach(function (arc) {
-            var concept = conceptMap.get(arc.from);
-            var labelResource = labelResources.find(function (r) { return r.label === arc.to; });
-            if (concept && labelResource) {
-                labels[concept] = labels[concept] || [];
-                labels[concept].push({
-                    text: labelResource.text || '',
-                    role: labelResource.role || '',
-                    lang: labelResource.lang || 'en',
-                });
-            }
-        });
-    });
-    return labels;
-}
-// Usage examples:
-function usageExamples() {
-    // Example: Get all revenue facts broken down by segment
-    var segmentRevenue = findFactsWithDimensions({}, // Your XBRL instance
-    'us-gaap:Revenues', [{ dimension: 'us-gaap:SegmentDomain' }]);
-    // Example: Get specific segment revenue
-    var northAmericaRevenue = findFactsWithDimensions({}, 'us-gaap:Revenues', [
-        {
-            dimension: 'us-gaap:SegmentDomain',
-            member: 'us-gaap:NorthAmericaSegmentMember',
-        },
-    ]);
-    return { segmentRevenue: segmentRevenue, northAmericaRevenue: northAmericaRevenue };
-}
-exports.usageExamples = usageExamples;

package/build/examples/xbrl-relationships.d.ts

@@ -1,145 +0,0 @@
-import type { XbrlInstance, XbrlLinkbase, XbrlSchema } from '../types';
-export declare class XbrlRelationshipBuilder {
-    private instance;
-    private schema;
-    private presentationLinkbase;
-    private calculationLinkbase;
-    private definitionLinkbase;
-    private labelLinkbase;
-    constructor(data: {
-        instance: XbrlInstance;
-        schema: XbrlSchema;
-        presentationLinkbase: XbrlLinkbase;
-        calculationLinkbase: XbrlLinkbase;
-        definitionLinkbase: XbrlLinkbase;
-        labelLinkbase: XbrlLinkbase;
-    });
-    /**
-     * 1. PRESENTATION LINKBASE - Defines hierarchical structure
-     * Shows how concepts are organized in financial statements
-     */
-    buildPresentationHierarchy(): Record<string, ConceptHierarchy>;
-    /**
-     * 2. CALCULATION LINKBASE - Defines mathematical relationships
-     * Shows how concepts add up to totals
-     */
-    buildCalculationRelationships(): Record<string, CalculationRelationship>;
-    /**
-     * 3. DEFINITION LINKBASE - Defines dimensional relationships
-     * Shows axis, members, domains, and hypercubes
-     */
-    buildDimensionalRelationships(): Record<string, DimensionalRelationship>;
-    /**
-     * 4. LABEL LINKBASE - Provides human-readable labels
-     * Maps concepts to their display labels
-     */
-    buildLabelMappings(): Record<string, ConceptLabel[]>;
-    /**
-     * 5. RELATING FACTS TO DIMENSIONS
-     * Shows how actual data values relate to dimensional context
-     */
-    buildFactDimensionalMappings(): FactDimensionalMapping[];
-    /**
-     * 6. COMPREHENSIVE TAXONOMY MAPPING
-     * Combines all relationships into a unified structure
-     */
-    buildComprehensiveTaxonomyMap(): {
-        presentation: Record<string, ConceptHierarchy>;
-        calculations: Record<string, CalculationRelationship>;
-        dimensions: Record<string, DimensionalRelationship>;
-        labels: Record<string, ConceptLabel[]>;
-        factMappings: FactDimensionalMapping[];
-        getConceptChildren: (concept: string) => ConceptChild[];
-        getConceptCalculation: (concept: string) => CalculationRelationship;
-        getConceptLabels: (concept: string) => ConceptLabel[];
-        getFactsForConcept: (concept: string) => FactDimensionalMapping[];
-        getDimensionsForConcept: (concept: string) => DimensionalRelationship;
-    };
-    private getLocators;
-    private getPresentationArcs;
-    private getCalculationArcs;
-    private getDefinitionArcs;
-    private getLabelArcs;
-    private getLabelResources;
-    private getConceptFromLocator;
-    private addHypercubeDimension;
-    private addDimensionDomain;
-    private addDomainMember;
-    private addAllRelationship;
-}
-interface ConceptHierarchy {
-    concept: string;
-    children: ConceptChild[];
-    order: number;
-    role: string;
-}
-interface ConceptChild {
-    concept: string;
-    order: number;
-    preferredLabel?: string;
-}
-interface CalculationRelationship {
-    summationItem: string;
-    contributingItems: CalculationItem[];
-}
-interface CalculationItem {
-    concept: string;
-    weight: number;
-    order: number;
-}
-interface DimensionalRelationship {
-    type: 'hypercube' | 'dimension' | 'domain' | 'member';
-    concept: string;
-    dimensions?: DimensionalItem[];
-    domains?: DimensionalItem[];
-    members?: DimensionalItem[];
-    all?: DimensionalItem[];
-}
-interface DimensionalItem {
-    concept: string;
-    type: string;
-}
-interface ConceptLabel {
-    text: string;
-    role: string;
-    lang: string;
-}
-interface FactDimensionalMapping {
-    factName: string;
-    value: string;
-    unit: string;
-    context: DimensionalContext;
-    contextRef: string;
-}
-interface DimensionalContext {
-    entity: string;
-    period: {
-        startDate?: string;
-        endDate?: string;
-        instant?: string;
-    };
-    dimensions: {
-        dimension: string;
-        member: string;
-    }[];
-}
-export declare function exampleUsage(xbrlData: {
-    instance: XbrlInstance;
-    schema: XbrlSchema;
-    presentationLinkbase: XbrlLinkbase;
-    calculationLinkbase: XbrlLinkbase;
-    definitionLinkbase: XbrlLinkbase;
-    labelLinkbase: XbrlLinkbase;
-}): {
-    presentation: Record<string, ConceptHierarchy>;
-    calculations: Record<string, CalculationRelationship>;
-    dimensions: Record<string, DimensionalRelationship>;
-    labels: Record<string, ConceptLabel[]>;
-    factMappings: FactDimensionalMapping[];
-    getConceptChildren: (concept: string) => ConceptChild[];
-    getConceptCalculation: (concept: string) => CalculationRelationship;
-    getConceptLabels: (concept: string) => ConceptLabel[];
-    getFactsForConcept: (concept: string) => FactDimensionalMapping[];
-    getDimensionsForConcept: (concept: string) => DimensionalRelationship;
-};
-export {};

package/build/examples/xbrl-relationships.js

@@ -1,337 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.exampleUsage = exports.XbrlRelationshipBuilder = void 0;
-/**
- * Example of how to use XBRL types to relate taxonomies, axis, members, and facts
- * using linkbases (calculation, presentation, definition, etc.)
- */
-var fs = require("fs");
-var __1 = require("..");
-// Example: Building a comprehensive XBRL relationship map
-var XbrlRelationshipBuilder = /** @class */ (function () {
-    function XbrlRelationshipBuilder(data) {
-        this.instance = data.instance;
-        this.schema = data.schema;
-        this.presentationLinkbase = data.presentationLinkbase;
-        this.calculationLinkbase = data.calculationLinkbase;
-        this.definitionLinkbase = data.definitionLinkbase;
-        this.labelLinkbase = data.labelLinkbase;
-    }
-    /**
-     * 1. PRESENTATION LINKBASE - Defines hierarchical structure
-     * Shows how concepts are organized in financial statements
-     */
-    XbrlRelationshipBuilder.prototype.buildPresentationHierarchy = function () {
-        var _this = this;
-        var _a;
-        var hierarchy = {};
-        // Process presentation links
-        (_a = this.presentationLinkbase.presentationLink) === null || _a === void 0 ? void 0 : _a.forEach(function (link) {
-            var roleUri = link.role || '';
-            // Get locators (concept references)
-            var locators = _this.getLocators(link);
-            var arcs = _this.getPresentationArcs(link);
-            // Build parent-child relationships
-            arcs.forEach(function (arc) {
-                var parentConcept = _this.getConceptFromLocator(locators, arc.from);
-                var childConcept = _this.getConceptFromLocator(locators, arc.to);
-                if (parentConcept && childConcept) {
-                    hierarchy[parentConcept] = hierarchy[parentConcept] || {
-                        concept: parentConcept,
-                        children: [],
-                        order: arc.order || 0,
-                        role: roleUri,
-                    };
-                    hierarchy[parentConcept].children.push({
-                        concept: childConcept,
-                        order: arc.order || 0,
-                        preferredLabel: arc.preferredLabel,
-                    });
-                }
-            });
-        });
-        return hierarchy;
-    };
-    /**
-     * 2. CALCULATION LINKBASE - Defines mathematical relationships
-     * Shows how concepts add up to totals
-     */
-    XbrlRelationshipBuilder.prototype.buildCalculationRelationships = function () {
-        var _this = this;
-        var _a;
-        var calculations = {};
-        (_a = this.calculationLinkbase.calculationLink) === null || _a === void 0 ? void 0 : _a.forEach(function (link) {
-            var locators = _this.getLocators(link);
-            var arcs = _this.getCalculationArcs(link);
-            arcs.forEach(function (arc) {
-                var summationConcept = _this.getConceptFromLocator(locators, arc.to);
-                var itemConcept = _this.getConceptFromLocator(locators, arc.from);
-                if (summationConcept && itemConcept) {
-                    calculations[summationConcept] = calculations[summationConcept] || {
-                        summationItem: summationConcept,
-                        contributingItems: [],
-                    };
-                    calculations[summationConcept].contributingItems.push({
-                        concept: itemConcept,
-                        weight: arc.weight || 1,
-                        order: arc.order || 0,
-                    });
-                }
-            });
-        });
-        return calculations;
-    };
-    /**
-     * 3. DEFINITION LINKBASE - Defines dimensional relationships
-     * Shows axis, members, domains, and hypercubes
-     */
-    XbrlRelationshipBuilder.prototype.buildDimensionalRelationships = function () {
-        var _this = this;
-        var _a;
-        var dimensions = {};
-        (_a = this.definitionLinkbase.definitionLink) === null || _a === void 0 ? void 0 : _a.forEach(function (link) {
-            var locators = _this.getLocators(link);
-            var arcs = _this.getDefinitionArcs(link);
-            arcs.forEach(function (arc) {
-                var arcrole = arc.arcrole || '';
-                var fromConcept = _this.getConceptFromLocator(locators, arc.from);
-                var toConcept = _this.getConceptFromLocator(locators, arc.to);
-                if (fromConcept && toConcept) {
-                    // Different arcroles define different relationship types
-                    switch (arcrole) {
-                        case 'http://xbrl.org/int/dim/arcrole/hypercube-dimension':
-                            // Hypercube to dimension relationship
-                            _this.addHypercubeDimension(dimensions, fromConcept, toConcept);
-                            break;
-                        case 'http://xbrl.org/int/dim/arcrole/dimension-domain':
-                            // Dimension to domain relationship
-                            _this.addDimensionDomain(dimensions, fromConcept, toConcept);
-                            break;
-                        case 'http://xbrl.org/int/dim/arcrole/domain-member':
-                            // Domain to member relationship
-                            _this.addDomainMember(dimensions, fromConcept, toConcept);
-                            break;
-                        case 'http://xbrl.org/int/dim/arcrole/all':
-                            // All relationship (for hypercubes)
-                            _this.addAllRelationship(dimensions, fromConcept, toConcept);
-                            break;
-                    }
-                }
-            });
-        });
-        return dimensions;
-    };
-    /**
-     * 4. LABEL LINKBASE - Provides human-readable labels
-     * Maps concepts to their display labels
-     */
-    XbrlRelationshipBuilder.prototype.buildLabelMappings = function () {
-        var _this = this;
-        var _a;
-        var labels = {};
-        (_a = this.labelLinkbase.labelLink) === null || _a === void 0 ? void 0 : _a.forEach(function (link) {
-            var locators = _this.getLocators(link);
-            var arcs = _this.getLabelArcs(link);
-            var labelResources = _this.getLabelResources(link);
-            arcs.forEach(function (arc) {
-                var concept = _this.getConceptFromLocator(locators, arc.from);
-                var labelResource = labelResources.find(function (r) { return r.label === arc.to; });
-                if (concept && labelResource) {
-                    labels[concept] = labels[concept] || [];
-                    labels[concept].push({
-                        text: labelResource.text || '',
-                        role: labelResource.role || '',
-                        lang: labelResource.lang || 'en',
-                    });
-                }
-            });
-        });
-        return labels;
-    };
-    /**
-     * 5. RELATING FACTS TO DIMENSIONS
-     * Shows how actual data values relate to dimensional context
-     */
-    XbrlRelationshipBuilder.prototype.buildFactDimensionalMappings = function () {
-        var _this = this;
-        var factMappings = [];
-        this.instance.factElements.forEach(function (fact) {
-            var context = _this.instance.contexts.find(function (c) { return c.id === fact.contextRef; });
-            if (context) {
-                var dimensionalContext = {
-                    entity: context.entity.identifier.value,
-                    period: context.period,
-                    dimensions: context.entity.segment.map(function (seg) { return ({
-                        dimension: seg.dimension,
-                        member: seg.value,
-                    }); }),
-                };
-                factMappings.push({
-                    factName: fact.name,
-                    value: fact.text || '',
-                    unit: fact.unitRef || '',
-                    context: dimensionalContext,
-                    contextRef: fact.contextRef,
-                });
-            }
-        });
-        return factMappings;
-    };
-    /**
-     * 6. COMPREHENSIVE TAXONOMY MAPPING
-     * Combines all relationships into a unified structure
-     */
-    XbrlRelationshipBuilder.prototype.buildComprehensiveTaxonomyMap = function () {
-        var presentation = this.buildPresentationHierarchy();
-        var calculations = this.buildCalculationRelationships();
-        var dimensions = this.buildDimensionalRelationships();
-        var labels = this.buildLabelMappings();
-        var factMappings = this.buildFactDimensionalMappings();
-        return {
-            presentation: presentation,
-            calculations: calculations,
-            dimensions: dimensions,
-            labels: labels,
-            factMappings: factMappings,
-            // Helper methods to navigate relationships
-            getConceptChildren: function (concept) { var _a; return ((_a = presentation[concept]) === null || _a === void 0 ? void 0 : _a.children) || []; },
-            getConceptCalculation: function (concept) { return calculations[concept]; },
-            getConceptLabels: function (concept) { return labels[concept] || []; },
-            getFactsForConcept: function (concept) { return factMappings.filter(function (f) { return f.factName === concept; }); },
-            getDimensionsForConcept: function (concept) { return dimensions[concept]; },
-        };
-    };
-    // Helper methods
-    XbrlRelationshipBuilder.prototype.getLocators = function (link) {
-        return (link.loc || []).filter(function (item) { return item.type === 'locator'; });
-    };
-    XbrlRelationshipBuilder.prototype.getPresentationArcs = function (link) {
-        return (link.presentationArc || []).filter(function (item) { return item.type === 'arc'; });
-    };
-    XbrlRelationshipBuilder.prototype.getCalculationArcs = function (link) {
-        return (link.calculationArc || []).filter(function (item) { return item.type === 'arc'; });
-    };
-    XbrlRelationshipBuilder.prototype.getDefinitionArcs = function (link) {
-        return (link.definitionArc || []).filter(function (item) { return item.type === 'arc'; });
-    };
-    XbrlRelationshipBuilder.prototype.getLabelArcs = function (link) {
-        return (link.labelArc || []).filter(function (item) { return item.type === 'arc'; });
-    };
-    XbrlRelationshipBuilder.prototype.getLabelResources = function (link) {
-        return (link.label || []).filter(function (item) { return item.type === 'resource'; });
-    };
-    XbrlRelationshipBuilder.prototype.getConceptFromLocator = function (locators, label) {
-        var locator = locators.find(function (loc) { return loc.label === label; });
-        if (!locator)
-            return null;
-        // Extract concept name from href (e.g., "concept.xsd#us-gaap_Assets")
-        var match = locator.href.match(/#(.+)$/);
-        return match ? match[1] : null;
-    };
-    XbrlRelationshipBuilder.prototype.addHypercubeDimension = function (dimensions, hypercube, dimension) {
-        dimensions[hypercube] = dimensions[hypercube] || { type: 'hypercube', concept: hypercube, dimensions: [] };
-        dimensions[hypercube].dimensions = dimensions[hypercube].dimensions || [];
-        dimensions[hypercube].dimensions.push({ concept: dimension, type: 'dimension' });
-    };
-    XbrlRelationshipBuilder.prototype.addDimensionDomain = function (dimensions, dimension, domain) {
-        dimensions[dimension] = dimensions[dimension] || { type: 'dimension', concept: dimension, domains: [] };
-        dimensions[dimension].domains = dimensions[dimension].domains || [];
-        dimensions[dimension].domains.push({ concept: domain, type: 'domain' });
-    };
-    XbrlRelationshipBuilder.prototype.addDomainMember = function (dimensions, domain, member) {
-        dimensions[domain] = dimensions[domain] || { type: 'domain', concept: domain, members: [] };
-        dimensions[domain].members = dimensions[domain].members || [];
-        dimensions[domain].members.push({ concept: member, type: 'member' });
-    };
-    XbrlRelationshipBuilder.prototype.addAllRelationship = function (dimensions, from, to) {
-        // Handle 'all' relationships for hypercubes
-        dimensions[from] = dimensions[from] || { type: 'hypercube', concept: from, all: [] };
-        dimensions[from].all = dimensions[from].all || [];
-        dimensions[from].all.push({ concept: to, type: 'all' });
-    };
-    return XbrlRelationshipBuilder;
-}());
-exports.XbrlRelationshipBuilder = XbrlRelationshipBuilder;
-// Example usage:
-function exampleUsage(xbrlData) {
-    var builder = new XbrlRelationshipBuilder(xbrlData);
-    var taxonomyMap = builder.buildComprehensiveTaxonomyMap();
-    // Example: Find all children of "Assets" concept
-    var assetChildren = taxonomyMap.getConceptChildren('us-gaap:Assets');
-    console.log('Asset children:', assetChildren);
-    // Example: Get calculation for "Assets" (what adds up to total assets)
-    var assetCalculation = taxonomyMap.getConceptCalculation('us-gaap:Assets');
-    console.log('Asset calculation:', assetCalculation);
-    // Example: Get all labels for "Assets" concept
-    var assetLabels = taxonomyMap.getConceptLabels('us-gaap:Assets');
-    console.log('Asset labels:', assetLabels);
-    // Example: Get all facts for "Assets" concept
-    var assetFacts = taxonomyMap.getFactsForConcept('us-gaap:Assets');
-    console.log('Asset facts:', assetFacts);
-    // Example: Get dimensional information for a concept
-    var assetDimensions = taxonomyMap.getDimensionsForConcept('us-gaap:Assets');
-    console.log('Asset dimensions:', assetDimensions);
-    return taxonomyMap;
-}
-exports.exampleUsage = exampleUsage;
-function runExample() {
-    return __awaiter(this, void 0, void 0, function () {
-        var res, builder;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, __1.secEdgarApi.getDocumentXbrl({
-                        url: 'https://www.sec.gov/Archives/edgar/data/320193/000032019324000123/0000320193-24-000123.txt',
-                    })];
-                case 1:
-                    res = _a.sent();
-                    builder = new XbrlRelationshipBuilder({
-                        calculationLinkbase: res.linkbaseCalculation.xbrl,
-                        definitionLinkbase: res.linkbaseDefinition.xbrl,
-                        instance: res.instance.xbrl,
-                        labelLinkbase: res.linkbaseLabel.xbrl,
-                        presentationLinkbase: res.linkbasePresentation.xbrl,
-                        schema: res.schema.xbrl,
-                    });
-                    fs.writeFileSync('fact-dimensional-mappings.json', JSON.stringify(builder.buildFactDimensionalMappings(), null, 2));
-                    return [2 /*return*/];
-            }
-        });
-    });
-}
-runExample();