@robosystems/client 0.3.7 → 0.3.9

package/artifacts/graphql/queries/ledger/informationBlock.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Information Block envelope — the cross-block-type read that replaces
+ * block-specific reads like `scheduleFacts` and (eventually)
+ * `statement`. Returns the assembled envelope with bundled atoms
+ * (elements, connections, facts) plus the typed artifact mechanics
+ * branch. See `local/docs/specs/information-block.md` §2.
+ */
+export declare const GET_INFORMATION_BLOCK: string;
+/**
+ * List Information Block envelopes with optional block_type + category
+ * filters. Each returned envelope has the same shape as the
+ * single-block read, so callers can page through ready-to-render
+ * blocks.
+ */
+export declare const LIST_INFORMATION_BLOCKS: string;

package/artifacts/graphql/queries/ledger/informationBlock.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LIST_INFORMATION_BLOCKS = exports.GET_INFORMATION_BLOCK = void 0;
+const graphql_request_1 = require("graphql-request");
+/**
+ * Information Block envelope — the cross-block-type read that replaces
+ * block-specific reads like `scheduleFacts` and (eventually)
+ * `statement`. Returns the assembled envelope with bundled atoms
+ * (elements, connections, facts) plus the typed artifact mechanics
+ * branch. See `local/docs/specs/information-block.md` §2.
+ */
+exports.GET_INFORMATION_BLOCK = (0, graphql_request_1.gql) `
+  query GetInformationBlock($id: ID!) {
+    informationBlock(id: $id) {
+      id
+      blockType
+      name
+      displayName
+      category
+      taxonomyId
+      taxonomyName
+      informationModel {
+        conceptArrangement
+        memberArrangement
+      }
+      artifact {
+        topic
+        parentheticalNote
+        template
+        mechanics
+      }
+      elements {
+        id
+        qname
+        name
+        code
+        elementType
+        isAbstract
+        isMonetary
+        balanceType
+        periodType
+      }
+      connections {
+        id
+        fromElementId
+        toElementId
+        associationType
+        arcrole
+        orderValue
+        weight
+      }
+      facts {
+        id
+        elementId
+        value
+        periodStart
+        periodEnd
+        periodType
+        unit
+        factScope
+        factSetId
+      }
+    }
+  }
+`;
+/**
+ * List Information Block envelopes with optional block_type + category
+ * filters. Each returned envelope has the same shape as the
+ * single-block read, so callers can page through ready-to-render
+ * blocks.
+ */
+exports.LIST_INFORMATION_BLOCKS = (0, graphql_request_1.gql) `
+  query ListInformationBlocks($blockType: String, $category: String, $limit: Int, $offset: Int) {
+    informationBlocks(blockType: $blockType, category: $category, limit: $limit, offset: $offset) {
+      id
+      blockType
+      name
+      displayName
+      category
+      taxonomyId
+      taxonomyName
+      informationModel {
+        conceptArrangement
+        memberArrangement
+      }
+      artifact {
+        topic
+        parentheticalNote
+        template
+        mechanics
+      }
+      elements {
+        id
+        qname
+        name
+        code
+        elementType
+        isAbstract
+        isMonetary
+        balanceType
+        periodType
+      }
+      connections {
+        id
+        fromElementId
+        toElementId
+        associationType
+        arcrole
+        orderValue
+        weight
+      }
+      facts {
+        id
+        elementId
+        value
+        periodStart
+        periodEnd
+        periodType
+        unit
+        factScope
+        factSetId
+      }
+    }
+  }
+`;

package/artifacts/graphql/queries/ledger/informationBlock.ts

@@ -0,0 +1,124 @@
+import { gql } from 'graphql-request'
+
+/**
+ * Information Block envelope — the cross-block-type read that replaces
+ * block-specific reads like `scheduleFacts` and (eventually)
+ * `statement`. Returns the assembled envelope with bundled atoms
+ * (elements, connections, facts) plus the typed artifact mechanics
+ * branch. See `local/docs/specs/information-block.md` §2.
+ */
+export const GET_INFORMATION_BLOCK = gql`
+  query GetInformationBlock($id: ID!) {
+    informationBlock(id: $id) {
+      id
+      blockType
+      name
+      displayName
+      category
+      taxonomyId
+      taxonomyName
+      informationModel {
+        conceptArrangement
+        memberArrangement
+      }
+      artifact {
+        topic
+        parentheticalNote
+        template
+        mechanics
+      }
+      elements {
+        id
+        qname
+        name
+        code
+        elementType
+        isAbstract
+        isMonetary
+        balanceType
+        periodType
+      }
+      connections {
+        id
+        fromElementId
+        toElementId
+        associationType
+        arcrole
+        orderValue
+        weight
+      }
+      facts {
+        id
+        elementId
+        value
+        periodStart
+        periodEnd
+        periodType
+        unit
+        factScope
+        factSetId
+      }
+    }
+  }
+`
+
+/**
+ * List Information Block envelopes with optional block_type + category
+ * filters. Each returned envelope has the same shape as the
+ * single-block read, so callers can page through ready-to-render
+ * blocks.
+ */
+export const LIST_INFORMATION_BLOCKS = gql`
+  query ListInformationBlocks($blockType: String, $category: String, $limit: Int, $offset: Int) {
+    informationBlocks(blockType: $blockType, category: $category, limit: $limit, offset: $offset) {
+      id
+      blockType
+      name
+      displayName
+      category
+      taxonomyId
+      taxonomyName
+      informationModel {
+        conceptArrangement
+        memberArrangement
+      }
+      artifact {
+        topic
+        parentheticalNote
+        template
+        mechanics
+      }
+      elements {
+        id
+        qname
+        name
+        code
+        elementType
+        isAbstract
+        isMonetary
+        balanceType
+        periodType
+      }
+      connections {
+        id
+        fromElementId
+        toElementId
+        associationType
+        arcrole
+        orderValue
+        weight
+      }
+      facts {
+        id
+        elementId
+        value
+        periodStart
+        periodEnd
+        periodType
+        unit
+        factScope
+        factSetId
+      }
+    }
+  }
+`

package/artifacts/graphql/queries/library/arcs.d.ts

@@ -0,0 +1,24 @@
+/**
+ * List every arc contributed by a taxonomy (via its structures) + the
+ * total count in one round-trip. For mapping taxonomies
+ * (fac-to-rs-gaap, sfac6-to-fac, type-subtype) this is the primary
+ * browse view — the arcs ARE what the taxonomy contributes.
+ */
+export declare const LIST_LIBRARY_TAXONOMY_ARCS: string;
+/**
+ * All mapping arcs where this element is source or target. Covers
+ * every `taxonomy_type='mapping'` bridge — equivalence,
+ * general-special, type-subtype. Each row is oriented from the
+ * element's perspective (`direction` = 'outgoing' | 'incoming').
+ */
+export declare const GET_LIBRARY_ELEMENT_ARCS: string;
+/**
+ * All classification traits assigned to an element — every category/identifier
+ * pair from element_classifications, sorted by category then identifier.
+ */
+export declare const GET_LIBRARY_ELEMENT_CLASSIFICATIONS: string;
+/**
+ * Equivalence fan-out (FAC ↔ us-gaap collapse). Returns the element
+ * and the peers that share an equivalence arc with it.
+ */
+export declare const GET_LIBRARY_ELEMENT_EQUIVALENTS: string;

package/artifacts/graphql/queries/library/arcs.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GET_LIBRARY_ELEMENT_EQUIVALENTS = exports.GET_LIBRARY_ELEMENT_CLASSIFICATIONS = exports.GET_LIBRARY_ELEMENT_ARCS = exports.LIST_LIBRARY_TAXONOMY_ARCS = void 0;
+const graphql_request_1 = require("graphql-request");
+/**
+ * List every arc contributed by a taxonomy (via its structures) + the
+ * total count in one round-trip. For mapping taxonomies
+ * (fac-to-rs-gaap, sfac6-to-fac, type-subtype) this is the primary
+ * browse view — the arcs ARE what the taxonomy contributes.
+ */
+exports.LIST_LIBRARY_TAXONOMY_ARCS = (0, graphql_request_1.gql) `
+  query ListLibraryTaxonomyArcs(
+    $taxonomyId: ID!
+    $associationType: String
+    $limit: Int! = 200
+    $offset: Int! = 0
+  ) {
+    libraryTaxonomyArcCount(taxonomyId: $taxonomyId)
+    libraryTaxonomyArcs(
+      taxonomyId: $taxonomyId
+      associationType: $associationType
+      limit: $limit
+      offset: $offset
+    ) {
+      id
+      structureId
+      structureName
+      fromElementId
+      fromElementQname
+      fromElementName
+      toElementId
+      toElementQname
+      toElementName
+      associationType
+      arcrole
+      orderValue
+      weight
+    }
+  }
+`;
+/**
+ * All mapping arcs where this element is source or target. Covers
+ * every `taxonomy_type='mapping'` bridge — equivalence,
+ * general-special, type-subtype. Each row is oriented from the
+ * element's perspective (`direction` = 'outgoing' | 'incoming').
+ */
+exports.GET_LIBRARY_ELEMENT_ARCS = (0, graphql_request_1.gql) `
+  query GetLibraryElementArcs($id: ID!) {
+    libraryElementArcs(id: $id) {
+      id
+      direction
+      associationType
+      arcrole
+      taxonomyId
+      taxonomyStandard
+      taxonomyName
+      structureId
+      structureName
+      peer {
+        id
+        qname
+        name
+        classification
+        source
+      }
+    }
+  }
+`;
+/**
+ * All classification traits assigned to an element — every category/identifier
+ * pair from element_classifications, sorted by category then identifier.
+ */
+exports.GET_LIBRARY_ELEMENT_CLASSIFICATIONS = (0, graphql_request_1.gql) `
+  query GetLibraryElementClassifications($id: ID!) {
+    libraryElementClassifications(id: $id) {
+      category
+      identifier
+      name
+      isPrimary
+    }
+  }
+`;
+/**
+ * Equivalence fan-out (FAC ↔ us-gaap collapse). Returns the element
+ * and the peers that share an equivalence arc with it.
+ */
+exports.GET_LIBRARY_ELEMENT_EQUIVALENTS = (0, graphql_request_1.gql) `
+  query GetLibraryElementEquivalents($id: ID!) {
+    libraryElementEquivalents(id: $id) {
+      element {
+        id
+        qname
+        name
+        classification
+        source
+      }
+      equivalents {
+        id
+        qname
+        name
+        classification
+        source
+      }
+    }
+  }
+`;

package/artifacts/graphql/queries/library/arcs.ts

@@ -0,0 +1,107 @@
+import { gql } from 'graphql-request'
+
+/**
+ * List every arc contributed by a taxonomy (via its structures) + the
+ * total count in one round-trip. For mapping taxonomies
+ * (fac-to-rs-gaap, sfac6-to-fac, type-subtype) this is the primary
+ * browse view — the arcs ARE what the taxonomy contributes.
+ */
+export const LIST_LIBRARY_TAXONOMY_ARCS = gql`
+  query ListLibraryTaxonomyArcs(
+    $taxonomyId: ID!
+    $associationType: String
+    $limit: Int! = 200
+    $offset: Int! = 0
+  ) {
+    libraryTaxonomyArcCount(taxonomyId: $taxonomyId)
+    libraryTaxonomyArcs(
+      taxonomyId: $taxonomyId
+      associationType: $associationType
+      limit: $limit
+      offset: $offset
+    ) {
+      id
+      structureId
+      structureName
+      fromElementId
+      fromElementQname
+      fromElementName
+      toElementId
+      toElementQname
+      toElementName
+      associationType
+      arcrole
+      orderValue
+      weight
+    }
+  }
+`
+
+/**
+ * All mapping arcs where this element is source or target. Covers
+ * every `taxonomy_type='mapping'` bridge — equivalence,
+ * general-special, type-subtype. Each row is oriented from the
+ * element's perspective (`direction` = 'outgoing' | 'incoming').
+ */
+export const GET_LIBRARY_ELEMENT_ARCS = gql`
+  query GetLibraryElementArcs($id: ID!) {
+    libraryElementArcs(id: $id) {
+      id
+      direction
+      associationType
+      arcrole
+      taxonomyId
+      taxonomyStandard
+      taxonomyName
+      structureId
+      structureName
+      peer {
+        id
+        qname
+        name
+        classification
+        source
+      }
+    }
+  }
+`
+
+/**
+ * All classification traits assigned to an element — every category/identifier
+ * pair from element_classifications, sorted by category then identifier.
+ */
+export const GET_LIBRARY_ELEMENT_CLASSIFICATIONS = gql`
+  query GetLibraryElementClassifications($id: ID!) {
+    libraryElementClassifications(id: $id) {
+      category
+      identifier
+      name
+      isPrimary
+    }
+  }
+`
+
+/**
+ * Equivalence fan-out (FAC ↔ us-gaap collapse). Returns the element
+ * and the peers that share an equivalence arc with it.
+ */
+export const GET_LIBRARY_ELEMENT_EQUIVALENTS = gql`
+  query GetLibraryElementEquivalents($id: ID!) {
+    libraryElementEquivalents(id: $id) {
+      element {
+        id
+        qname
+        name
+        classification
+        source
+      }
+      equivalents {
+        id
+        qname
+        name
+        classification
+        source
+      }
+    }
+  }
+`

package/artifacts/graphql/queries/library/elements.d.ts

@@ -0,0 +1,24 @@
+/**
+ * List library elements with filters + pagination.
+ *
+ * `classification` filters on the FASB elementsOfFinancialStatements axis.
+ * `activityType` filters on the cash-flow activity axis
+ * (operatingActivity / investingActivity / financingActivity). Both axes
+ * apply independently and can be combined.
+ *
+ * `isAbstract=true` → abstract only; `false` → concrete only; omit for both.
+ *
+ * `includeLabels` / `includeReferences` default `false`; the list view
+ * doesn't render them and they add N+1-ish payload weight.
+ */
+export declare const LIST_LIBRARY_ELEMENTS: string;
+/**
+ * Substring search across qname, name, and standard label text.
+ * Always returns labels + references inline — the search UI renders them.
+ */
+export declare const SEARCH_LIBRARY_ELEMENTS: string;
+/**
+ * Get a single element by id or by qname ('sfac6:Assets', etc).
+ * Returns null when neither identifier resolves.
+ */
+export declare const GET_LIBRARY_ELEMENT: string;

package/artifacts/graphql/queries/library/elements.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GET_LIBRARY_ELEMENT = exports.SEARCH_LIBRARY_ELEMENTS = exports.LIST_LIBRARY_ELEMENTS = void 0;
+const graphql_request_1 = require("graphql-request");
+/**
+ * List library elements with filters + pagination.
+ *
+ * `classification` filters on the FASB elementsOfFinancialStatements axis.
+ * `activityType` filters on the cash-flow activity axis
+ * (operatingActivity / investingActivity / financingActivity). Both axes
+ * apply independently and can be combined.
+ *
+ * `isAbstract=true` → abstract only; `false` → concrete only; omit for both.
+ *
+ * `includeLabels` / `includeReferences` default `false`; the list view
+ * doesn't render them and they add N+1-ish payload weight.
+ */
+exports.LIST_LIBRARY_ELEMENTS = (0, graphql_request_1.gql) `
+  query ListLibraryElements(
+    $taxonomyId: ID
+    $source: String
+    $classification: String
+    $activityType: String
+    $elementType: String
+    $isAbstract: Boolean
+    $limit: Int! = 50
+    $offset: Int! = 0
+    $includeLabels: Boolean! = false
+    $includeReferences: Boolean! = false
+  ) {
+    libraryElements(
+      taxonomyId: $taxonomyId
+      source: $source
+      classification: $classification
+      activityType: $activityType
+      elementType: $elementType
+      isAbstract: $isAbstract
+      limit: $limit
+      offset: $offset
+      includeLabels: $includeLabels
+      includeReferences: $includeReferences
+    ) {
+      id
+      qname
+      namespace
+      name
+      classification
+      balanceType
+      periodType
+      isAbstract
+      isMonetary
+      elementType
+      source
+      taxonomyId
+      parentId
+      labels @include(if: $includeLabels) {
+        role
+        language
+        text
+      }
+      references @include(if: $includeReferences) {
+        refType
+        citation
+        uri
+      }
+    }
+  }
+`;
+/**
+ * Substring search across qname, name, and standard label text.
+ * Always returns labels + references inline — the search UI renders them.
+ */
+exports.SEARCH_LIBRARY_ELEMENTS = (0, graphql_request_1.gql) `
+  query SearchLibraryElements($query: String!, $source: String, $limit: Int! = 50) {
+    searchLibraryElements(query: $query, source: $source, limit: $limit) {
+      id
+      qname
+      namespace
+      name
+      classification
+      balanceType
+      periodType
+      isAbstract
+      isMonetary
+      elementType
+      source
+      taxonomyId
+      parentId
+      labels {
+        role
+        language
+        text
+      }
+      references {
+        refType
+        citation
+        uri
+      }
+    }
+  }
+`;
+/**
+ * Get a single element by id or by qname ('sfac6:Assets', etc).
+ * Returns null when neither identifier resolves.
+ */
+exports.GET_LIBRARY_ELEMENT = (0, graphql_request_1.gql) `
+  query GetLibraryElement($id: ID, $qname: String) {
+    libraryElement(id: $id, qname: $qname) {
+      id
+      qname
+      namespace
+      name
+      classification
+      balanceType
+      periodType
+      isAbstract
+      isMonetary
+      elementType
+      source
+      taxonomyId
+      parentId
+      labels {
+        role
+        language
+        text
+      }
+      references {
+        refType
+        citation
+        uri
+      }
+    }
+  }
+`;