@robosystems/client 0.3.33 → 0.3.35

package/artifacts/LedgerClient.d.ts

@@ -1,6 +1,6 @@
 import type { AssociationResponse, AutoMapElementsOperation, CreateAgentRequest, CreateEventBlockRequest, CreateEventHandlerRequest, CreateInformationBlockRequest, CreateMappingAssociationOperation, CreateTaxonomyBlockRequest, CreateViewRequest, DeleteInformationBlockRequest, DeleteInformationBlockResponse, DeleteMappingAssociationOperation, DeleteResult, DeleteTaxonomyBlockRequest, DeleteTaxonomyBlockResponse, EntityTaxonomyResponse, EvaluateRulesRequest, EvaluateRulesResponse, EventBlockEnvelope, EventHandlerResponse, FinancialStatementAnalysisRequest, InformationBlockEnvelope, JournalEntryResponse, LedgerAgentResponse, LinkEntityTaxonomyRequest, LiveFinancialStatementRequest, OperationEnvelope, PreviewEventBlockResponse, PublishListMemberResponse, PublishListResponse, ReportResponse, ShareReportResponse, TaxonomyBlockEnvelope, UpdateAgentRequest, UpdateEntityRequest, UpdateEventBlockRequest, UpdateEventHandlerRequest, UpdateInformationBlockRequest, UpdateJournalEntryRequest, UpdateTaxonomyBlockRequest } from '../types.gen';
 import type { TokenProvider } from './graphql/client';
-import { type GetInformationBlockQuery, type GetLedgerAccountRollupsQuery, type GetLedgerAccountTreeQuery, type GetLedgerAgentQuery, type GetLedgerClosingBookStructuresQuery, type GetLedgerEntityQuery, type GetLedgerEventBlockQuery, type GetLedgerFiscalCalendarQuery, type GetLedgerMappedTrialBalanceQuery, type GetLedgerMappingCoverageQuery, type GetLedgerMappingQuery, type GetLedgerPeriodCloseStatusQuery, type GetLedgerPeriodDraftsQuery, type GetLedgerPublishListQuery, type GetLedgerReportingTaxonomyQuery, type GetLedgerReportPackageQuery, type GetLedgerReportQuery, type GetLedgerStatementQuery, type GetLedgerSummaryQuery, type GetLedgerTransactionQuery, type GetLedgerTrialBalanceQuery, type ListInformationBlocksQuery, type ListLedgerAccountsQuery, type ListLedgerAgentsQuery, type ListLedgerElementsQuery, type ListLedgerEntitiesQuery, type ListLedgerEventBlocksQuery, type ListLedgerMappingsQuery, type ListLedgerPublishListsQuery, type ListLedgerReportsQuery, type ListLedgerStructuresQuery, type ListLedgerTaxonomiesQuery, type ListLedgerTransactionsQuery, type ListLedgerUnmappedElementsQuery } from './graphql/generated/graphql';
+import { type GetInformationBlockQuery, type GetLedgerAccountRollupsQuery, type GetLedgerAccountTreeQuery, type GetLedgerAgentQuery, type GetLedgerClosingBookStructuresQuery, type GetLedgerEntityQuery, type GetLedgerEventBlockQuery, type GetLedgerFiscalCalendarQuery, type GetLedgerMappedTrialBalanceQuery, type GetLedgerMappingCoverageQuery, type GetLedgerMappingQuery, type GetLedgerPeriodCloseStatusQuery, type GetLedgerPeriodDraftsQuery, type GetLedgerPublishListQuery, type GetLedgerReportingTaxonomyQuery, type GetLedgerReportPackageQuery, type GetLedgerReportQuery, type GetLedgerStatementQuery, type GetLedgerSummaryQuery, type GetLedgerTransactionQuery, type GetLedgerTrialBalanceQuery, type ListInformationBlocksQuery, type ListLedgerAccountsQuery, type ListLedgerAgentsQuery, type ListLedgerElementsQuery, type ListLedgerEntitiesQuery, type ListLedgerEventBlocksQuery, type ListLedgerMappingsQuery, type ListLedgerPublishListsQuery, type ListLedgerReportsQuery, type ListLedgerStructuresQuery, type ListLedgerTaxonomiesQuery, type ListLedgerTransactionsQuery, type ListLedgerUnmappedElementsQuery, type MappingCandidatesQuery } from './graphql/generated/graphql';
 export type LedgerEntity = NonNullable<GetLedgerEntityQuery['entity']>;
 export type LedgerEntitySummary = ListLedgerEntitiesQuery['entities'][number];
 export type LedgerSummary = NonNullable<GetLedgerSummaryQuery['summary']>;
@@ -22,6 +22,7 @@ export type LedgerTaxonomyList = NonNullable<ListLedgerTaxonomiesQuery['taxonomi
 export type LedgerTaxonomy = LedgerTaxonomyList['taxonomies'][number];
 export type LedgerElementList = NonNullable<ListLedgerElementsQuery['elements']>;
 export type LedgerElement = LedgerElementList['elements'][number];
+export type LedgerMappingCandidate = MappingCandidatesQuery['mappingCandidates'][number];
 export type LedgerUnmappedElement = ListLedgerUnmappedElementsQuery['unmappedElements'][number];
 export type LedgerStructureList = NonNullable<ListLedgerStructuresQuery['structures']>;
 export type LedgerStructure = LedgerStructureList['structures'][number];
@@ -52,6 +53,27 @@ export type StatementRow = StatementData['rows'][number];
 export type PublishList = NonNullable<ListLedgerPublishListsQuery['publishLists']>['publishLists'][number];
 export type PublishListDetail = NonNullable<GetLedgerPublishListQuery['publishList']>;
 export type PublishListMember = PublishListDetail['members'][number];
+/**
+ * Presigned-URL response for a Report bundle download.
+ *
+ * Returned by ``LedgerClient.getReportBundleDownloadUrl`` — the
+ * ``downloadUrl`` is a time-limited URL that streams the
+ * serialization artifact directly from object storage. Browser
+ * callers typically follow the URL via ``window.location.href`` or
+ * an anchor element to trigger the file download.
+ */
+export interface ReportBundleDownloadResponse {
+    /** Presigned URL that streams the bundle directly from S3. */
+    downloadUrl: string;
+    /** ISO-8601 UTC instant at which the presigned URL stops working. */
+    expiresAt: string;
+    /** MIME type of the artifact behind the URL. */
+    contentType: string;
+    /** Serialization flavor — ``jsonld`` is the Phase 1a default. */
+    format: string;
+    /** Bundle generation number stamped on the Report. */
+    generationCount: number;
+}
 export interface PeriodSpecInput {
     start: string;
     end: string;
@@ -299,6 +321,14 @@ export declare class LedgerClient {
         limit?: number;
         offset?: number;
     }): Promise<LedgerElementList | null>;
+    /**
+     * rs-gaap concepts a CoA element of the given EFS `classification`
+     * (asset / liability / equity / revenue / expense) may map to — limited
+     * to concepts that render under the graph's active Reporting Style, with
+     * statement-level subtotals excluded. Use this to populate the mapping
+     * picker so it never offers an unreachable target.
+     */
+    getMappingCandidates(graphId: string, classification: string): Promise<LedgerMappingCandidate[]>;
     /** CoA elements not yet mapped to a reporting concept. */
     listUnmappedElements(graphId: string, options?: {
         mappingId?: string;
@@ -553,6 +583,32 @@ export declare class LedgerClient {
     regenerateReport(graphId: string, reportId: string, periodStart?: string, periodEnd?: string): Promise<ReportOperationAck<ReportResponse>>;
     /** Delete a report and its generated facts. */
     deleteReport(graphId: string, reportId: string): Promise<DeleteResult>;
+    /**
+     * Get a short-lived presigned URL for downloading a published
+     * Report's serialization bundle.
+     *
+     * Phase 1a only resolves the JSON-LD flavor; reserved RDF and XBRL
+     * flavors return HTTP 400 until their producers ship. Reports
+     * published before the serialization feature shipped will resolve
+     * to a 404 — those Reports have no stamped bundle_url and must be
+     * regenerated to produce one.
+     *
+     * The returned ``downloadUrl`` is a presigned S3 URL valid for
+     * ``expiresIn`` seconds (default 300, max 3600). Browser callers
+     * typically navigate to it via ``window.location.href`` (or assign
+     * to an `<a href>` and click) to trigger the file download; the
+     * server-set Content-Disposition forces "attachment" with a
+     * versioned filename.
+     *
+     * @param graphId Graph identifier owning the Report.
+     * @param reportId Report identifier (rpt_-prefixed ULID).
+     * @param options.format Serialization flavor — defaults to ``'jsonld'``.
+     * @param options.expiresIn Presigned URL lifetime, in seconds.
+     */
+    getReportBundleDownloadUrl(graphId: string, reportId: string, options?: {
+        format?: string;
+        expiresIn?: number;
+    }): Promise<ReportBundleDownloadResponse>;
     /**
      * Share a published report to every member of a publish list. Each
      * target graph receives a snapshot copy of the report's facts.
@@ -609,5 +665,14 @@ export declare class LedgerClient {
      * sign that a synchronous operation failed silently.
      */
     private requireResult;
+    /**
+     * Resolve the current bearer token / API key for non-GraphQL REST
+     * calls. Mirrors the GraphQL client's behaviour — dynamic
+     * ``tokenProvider`` is consulted first (so JWT rotation flows
+     * naturally), then the static ``token`` config. Returns ``null``
+     * when no credential is configured; the caller decides whether to
+     * proceed anonymously or short-circuit with an error.
+     */
+    private resolveToken;
 }
 export {};

package/artifacts/LedgerClient.js

@@ -182,6 +182,16 @@ class LedgerClient {
             offset: options?.offset ?? 0,
         }, 'List elements', (data) => data.elements);
     }
+    /**
+     * rs-gaap concepts a CoA element of the given EFS `classification`
+     * (asset / liability / equity / revenue / expense) may map to — limited
+     * to concepts that render under the graph's active Reporting Style, with
+     * statement-level subtotals excluded. Use this to populate the mapping
+     * picker so it never offers an unreachable target.
+     */
+    async getMappingCandidates(graphId, classification) {
+        return this.gqlQuery(graphId, graphql_1.MappingCandidatesDocument, { classification }, 'Mapping candidates', (data) => data.mappingCandidates);
+    }
     /** CoA elements not yet mapped to a reporting concept. */
     async listUnmappedElements(graphId, options) {
         return this.gqlQuery(graphId, graphql_1.ListLedgerUnmappedElementsDocument, { mappingId: options?.mappingId ?? null }, 'List unmapped elements', (data) => data.unmappedElements);
@@ -687,7 +697,7 @@ class LedgerClient {
             mapping_id: options.mappingId,
             period_start: options.periodStart,
             period_end: options.periodEnd,
-            taxonomy_id: options.taxonomyId ?? 'tax_usgaap_reporting',
+            taxonomy_id: options.taxonomyId ?? 'rs-gaap',
             period_type: options.periodType ?? 'quarterly',
             comparative: options.comparative ?? true,
         };
@@ -754,6 +764,66 @@ class LedgerClient {
         }));
         return (envelope.result ?? { deleted: true });
     }
+    /**
+     * Get a short-lived presigned URL for downloading a published
+     * Report's serialization bundle.
+     *
+     * Phase 1a only resolves the JSON-LD flavor; reserved RDF and XBRL
+     * flavors return HTTP 400 until their producers ship. Reports
+     * published before the serialization feature shipped will resolve
+     * to a 404 — those Reports have no stamped bundle_url and must be
+     * regenerated to produce one.
+     *
+     * The returned ``downloadUrl`` is a presigned S3 URL valid for
+     * ``expiresIn`` seconds (default 300, max 3600). Browser callers
+     * typically navigate to it via ``window.location.href`` (or assign
+     * to an `<a href>` and click) to trigger the file download; the
+     * server-set Content-Disposition forces "attachment" with a
+     * versioned filename.
+     *
+     * @param graphId Graph identifier owning the Report.
+     * @param reportId Report identifier (rpt_-prefixed ULID).
+     * @param options.format Serialization flavor — defaults to ``'jsonld'``.
+     * @param options.expiresIn Presigned URL lifetime, in seconds.
+     */
+    async getReportBundleDownloadUrl(graphId, reportId, options = {}) {
+        const format = options.format ?? 'jsonld';
+        const expiresIn = options.expiresIn ?? 300;
+        const url = `${this.config.baseUrl.replace(/\/$/, '')}` +
+            `/extensions/roboledger/${encodeURIComponent(graphId)}` +
+            `/reports/${encodeURIComponent(reportId)}/download` +
+            `?format=${encodeURIComponent(format)}&expires_in=${expiresIn}`;
+        const headers = new Headers({ Accept: 'application/json', ...(this.config.headers ?? {}) });
+        const token = await this.resolveToken();
+        if (token) {
+            // ``rfs…`` long-lived keys go in X-API-Key; everything else is
+            // a short-lived JWT. Mirrors the GraphQL client behaviour at
+            // ``clients/graphql/client.ts``.
+            if (token.startsWith('rfs')) {
+                headers.set('X-API-Key', token);
+            }
+            else {
+                headers.set('Authorization', `Bearer ${token}`);
+            }
+        }
+        const response = await fetch(url, {
+            method: 'GET',
+            headers,
+            credentials: this.config.credentials,
+        });
+        if (!response.ok) {
+            const body = await response.text();
+            throw new Error(`Get report bundle download URL failed (${response.status}): ${body}`);
+        }
+        const raw = (await response.json());
+        return {
+            downloadUrl: raw.download_url,
+            expiresAt: raw.expires_at,
+            contentType: raw.content_type,
+            format: raw.format,
+            generationCount: raw.generation_count,
+        };
+    }
     /**
      * Share a published report to every member of a publish list. Each
      * target graph receives a snapshot copy of the report's facts.
@@ -900,6 +970,27 @@ class LedgerClient {
         }
         return result;
     }
+    /**
+     * Resolve the current bearer token / API key for non-GraphQL REST
+     * calls. Mirrors the GraphQL client's behaviour — dynamic
+     * ``tokenProvider`` is consulted first (so JWT rotation flows
+     * naturally), then the static ``token`` config. Returns ``null``
+     * when no credential is configured; the caller decides whether to
+     * proceed anonymously or short-circuit with an error.
+     */
+    async resolveToken() {
+        if (this.config.tokenProvider) {
+            try {
+                const token = await this.config.tokenProvider();
+                return token ?? null;
+            }
+            catch (err) {
+                console.warn('[RoboSystems SDK] tokenProvider threw — sending unauthenticated request:', err);
+                return null;
+            }
+        }
+        return this.config.token ?? null;
+    }
 }
 exports.LedgerClient = LedgerClient;
 // ── Module-private conversion helpers ─────────────────────────────────

package/artifacts/LedgerClient.ts

@@ -155,6 +155,7 @@ import {
   ListLedgerTaxonomiesDocument,
   ListLedgerTransactionsDocument,
   ListLedgerUnmappedElementsDocument,
+  MappingCandidatesDocument,
   type GetInformationBlockQuery,
   type GetLedgerAccountRollupsQuery,
   type GetLedgerAccountTreeQuery,
@@ -189,6 +190,7 @@ import {
   type ListLedgerTaxonomiesQuery,
   type ListLedgerTransactionsQuery,
   type ListLedgerUnmappedElementsQuery,
+  type MappingCandidatesQuery,
 } from './graphql/generated/graphql'
 
 // ── Friendly types derived from GraphQL codegen ────────────────────────
@@ -231,6 +233,7 @@ export type LedgerTaxonomy = LedgerTaxonomyList['taxonomies'][number]
 
 export type LedgerElementList = NonNullable<ListLedgerElementsQuery['elements']>
 export type LedgerElement = LedgerElementList['elements'][number]
+export type LedgerMappingCandidate = MappingCandidatesQuery['mappingCandidates'][number]
 export type LedgerUnmappedElement = ListLedgerUnmappedElementsQuery['unmappedElements'][number]
 
 export type LedgerStructureList = NonNullable<ListLedgerStructuresQuery['structures']>
@@ -277,6 +280,36 @@ export type PublishList = NonNullable<
 export type PublishListDetail = NonNullable<GetLedgerPublishListQuery['publishList']>
 export type PublishListMember = PublishListDetail['members'][number]
 
+/**
+ * Presigned-URL response for a Report bundle download.
+ *
+ * Returned by ``LedgerClient.getReportBundleDownloadUrl`` — the
+ * ``downloadUrl`` is a time-limited URL that streams the
+ * serialization artifact directly from object storage. Browser
+ * callers typically follow the URL via ``window.location.href`` or
+ * an anchor element to trigger the file download.
+ */
+export interface ReportBundleDownloadResponse {
+  /** Presigned URL that streams the bundle directly from S3. */
+  downloadUrl: string
+  /** ISO-8601 UTC instant at which the presigned URL stops working. */
+  expiresAt: string
+  /** MIME type of the artifact behind the URL. */
+  contentType: string
+  /** Serialization flavor — ``jsonld`` is the Phase 1a default. */
+  format: string
+  /** Bundle generation number stamped on the Report. */
+  generationCount: number
+}
+
+interface RawReportBundleDownloadResponse {
+  download_url: string
+  expires_at: string
+  content_type: string
+  format: string
+  generation_count: number
+}
+
 export interface PeriodSpecInput {
   start: string
   end: string
@@ -887,6 +920,26 @@ export class LedgerClient {
     )
   }
 
+  /**
+   * rs-gaap concepts a CoA element of the given EFS `classification`
+   * (asset / liability / equity / revenue / expense) may map to — limited
+   * to concepts that render under the graph's active Reporting Style, with
+   * statement-level subtotals excluded. Use this to populate the mapping
+   * picker so it never offers an unreachable target.
+   */
+  async getMappingCandidates(
+    graphId: string,
+    classification: string
+  ): Promise<LedgerMappingCandidate[]> {
+    return this.gqlQuery(
+      graphId,
+      MappingCandidatesDocument,
+      { classification },
+      'Mapping candidates',
+      (data) => data.mappingCandidates
+    )
+  }
+
   /** CoA elements not yet mapped to a reporting concept. */
   async listUnmappedElements(
     graphId: string,
@@ -1730,7 +1783,7 @@ export class LedgerClient {
       mapping_id: options.mappingId,
       period_start: options.periodStart,
       period_end: options.periodEnd,
-      taxonomy_id: options.taxonomyId ?? 'tax_usgaap_reporting',
+      taxonomy_id: options.taxonomyId ?? 'rs-gaap',
       period_type: options.periodType ?? 'quarterly',
       comparative: options.comparative ?? true,
     }
@@ -1846,6 +1899,71 @@ export class LedgerClient {
     return (envelope.result ?? { deleted: true }) as DeleteResult
   }
 
+  /**
+   * Get a short-lived presigned URL for downloading a published
+   * Report's serialization bundle.
+   *
+   * Phase 1a only resolves the JSON-LD flavor; reserved RDF and XBRL
+   * flavors return HTTP 400 until their producers ship. Reports
+   * published before the serialization feature shipped will resolve
+   * to a 404 — those Reports have no stamped bundle_url and must be
+   * regenerated to produce one.
+   *
+   * The returned ``downloadUrl`` is a presigned S3 URL valid for
+   * ``expiresIn`` seconds (default 300, max 3600). Browser callers
+   * typically navigate to it via ``window.location.href`` (or assign
+   * to an `<a href>` and click) to trigger the file download; the
+   * server-set Content-Disposition forces "attachment" with a
+   * versioned filename.
+   *
+   * @param graphId Graph identifier owning the Report.
+   * @param reportId Report identifier (rpt_-prefixed ULID).
+   * @param options.format Serialization flavor — defaults to ``'jsonld'``.
+   * @param options.expiresIn Presigned URL lifetime, in seconds.
+   */
+  async getReportBundleDownloadUrl(
+    graphId: string,
+    reportId: string,
+    options: { format?: string; expiresIn?: number } = {}
+  ): Promise<ReportBundleDownloadResponse> {
+    const format = options.format ?? 'jsonld'
+    const expiresIn = options.expiresIn ?? 300
+    const url =
+      `${this.config.baseUrl.replace(/\/$/, '')}` +
+      `/extensions/roboledger/${encodeURIComponent(graphId)}` +
+      `/reports/${encodeURIComponent(reportId)}/download` +
+      `?format=${encodeURIComponent(format)}&expires_in=${expiresIn}`
+    const headers = new Headers({ Accept: 'application/json', ...(this.config.headers ?? {}) })
+    const token = await this.resolveToken()
+    if (token) {
+      // ``rfs…`` long-lived keys go in X-API-Key; everything else is
+      // a short-lived JWT. Mirrors the GraphQL client behaviour at
+      // ``clients/graphql/client.ts``.
+      if (token.startsWith('rfs')) {
+        headers.set('X-API-Key', token)
+      } else {
+        headers.set('Authorization', `Bearer ${token}`)
+      }
+    }
+    const response = await fetch(url, {
+      method: 'GET',
+      headers,
+      credentials: this.config.credentials,
+    })
+    if (!response.ok) {
+      const body = await response.text()
+      throw new Error(`Get report bundle download URL failed (${response.status}): ${body}`)
+    }
+    const raw = (await response.json()) as RawReportBundleDownloadResponse
+    return {
+      downloadUrl: raw.download_url,
+      expiresAt: raw.expires_at,
+      contentType: raw.content_type,
+      format: raw.format,
+      generationCount: raw.generation_count,
+    }
+  }
+
   /**
    * Share a published report to every member of a publish list. Each
    * target graph receives a snapshot copy of the report's facts.
@@ -2072,6 +2190,30 @@ export class LedgerClient {
     }
     return result
   }
+
+  /**
+   * Resolve the current bearer token / API key for non-GraphQL REST
+   * calls. Mirrors the GraphQL client's behaviour — dynamic
+   * ``tokenProvider`` is consulted first (so JWT rotation flows
+   * naturally), then the static ``token`` config. Returns ``null``
+   * when no credential is configured; the caller decides whether to
+   * proceed anonymously or short-circuit with an error.
+   */
+  private async resolveToken(): Promise<string | null> {
+    if (this.config.tokenProvider) {
+      try {
+        const token = await this.config.tokenProvider()
+        return token ?? null
+      } catch (err) {
+        console.warn(
+          '[RoboSystems SDK] tokenProvider threw — sending unauthenticated request:',
+          err
+        )
+        return null
+      }
+    }
+    return this.config.token ?? null
+  }
 }
 
 // ── Module-private conversion helpers ─────────────────────────────────

package/artifacts/graphql/generated/graphql.d.ts

@@ -1451,6 +1451,7 @@ export type Query = {
     libraryTaxonomyArcs: Array<LibraryAssociation>;
     mappedTrialBalance: Maybe<MappedTrialBalance>;
     mapping: Maybe<MappingDetail>;
+    mappingCandidates: Array<Element>;
     mappingCoverage: Maybe<MappingCoverage>;
     mappings: Maybe<StructureList>;
     openPayables: OpenBalanceAggregate;
@@ -1609,6 +1610,9 @@ export type QueryMappedTrialBalanceArgs = {
 export type QueryMappingArgs = {
     mappingId: Scalars['String']['input'];
 };
+export type QueryMappingCandidatesArgs = {
+    classification: Scalars['String']['input'];
+};
 export type QueryMappingCoverageArgs = {
     mappingId: Scalars['String']['input'];
 };
@@ -2474,6 +2478,7 @@ export type ListLedgerElementsQuery = {
             description: string | null;
             qname: string | null;
             namespace: string | null;
+            trait: string | null;
             subClassification: string | null;
             balanceType: string;
             periodType: string;
@@ -2968,6 +2973,17 @@ export type GetLedgerMappingQuery = {
         }>;
     } | null;
 };
+export type MappingCandidatesQueryVariables = Exact<{
+    classification: Scalars['String']['input'];
+}>;
+export type MappingCandidatesQuery = {
+    mappingCandidates: Array<{
+        id: string;
+        name: string;
+        qname: string | null;
+        trait: string | null;
+    }>;
+};
 export type GetLedgerMappingCoverageQueryVariables = Exact<{
     mappingId: Scalars['String']['input'];
 }>;
@@ -3791,6 +3807,7 @@ export declare const GetInformationBlockDocument: DocumentNode<GetInformationBlo
 export declare const ListInformationBlocksDocument: DocumentNode<ListInformationBlocksQuery, ListInformationBlocksQueryVariables>;
 export declare const GetLedgerMappedTrialBalanceDocument: DocumentNode<GetLedgerMappedTrialBalanceQuery, GetLedgerMappedTrialBalanceQueryVariables>;
 export declare const GetLedgerMappingDocument: DocumentNode<GetLedgerMappingQuery, GetLedgerMappingQueryVariables>;
+export declare const MappingCandidatesDocument: DocumentNode<MappingCandidatesQuery, MappingCandidatesQueryVariables>;
 export declare const GetLedgerMappingCoverageDocument: DocumentNode<GetLedgerMappingCoverageQuery, GetLedgerMappingCoverageQueryVariables>;
 export declare const ListLedgerMappingsDocument: DocumentNode<ListLedgerMappingsQuery, ListLedgerMappingsQueryVariables>;
 export declare const GetLedgerPeriodCloseStatusDocument: DocumentNode<GetLedgerPeriodCloseStatusQuery, GetLedgerPeriodCloseStatusQueryVariables>;

package/artifacts/graphql/generated/graphql.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetLibraryTaxonomyDocument = exports.ListLibraryTaxonomiesDocument = exports.GetLibraryElementDocument = exports.SearchLibraryElementsDocument = exports.ListLibraryElementsDocument = exports.GetLibraryElementEquivalentsDocument = exports.GetLibraryElementClassificationsDocument = exports.GetLibraryElementArcsDocument = exports.ListLibraryTaxonomyArcsDocument = exports.ListLedgerUnmappedElementsDocument = exports.GetLedgerTrialBalanceDocument = exports.ListLedgerTransactionsDocument = exports.GetLedgerTransactionDocument = exports.ListLedgerTaxonomiesDocument = exports.GetLedgerSummaryDocument = exports.ListLedgerStructuresDocument = exports.GetLedgerStatementDocument = exports.ListLedgerReportsDocument = exports.GetLedgerReportingTaxonomyDocument = exports.GetLedgerReportPackageDocument = exports.GetLedgerReportDocument = exports.ListLedgerPublishListsDocument = exports.GetLedgerPublishListDocument = exports.GetLedgerPeriodDraftsDocument = exports.GetLedgerPeriodCloseStatusDocument = exports.ListLedgerMappingsDocument = exports.GetLedgerMappingCoverageDocument = exports.GetLedgerMappingDocument = exports.GetLedgerMappedTrialBalanceDocument = exports.ListInformationBlocksDocument = exports.GetInformationBlockDocument = exports.GetLedgerFiscalCalendarDocument = exports.ListLedgerEventBlocksDocument = exports.GetLedgerEventBlockDocument = exports.GetLedgerEntityDocument = exports.ListLedgerEntitiesDocument = exports.ListLedgerElementsDocument = exports.GetLedgerClosingBookStructuresDocument = exports.ListLedgerAgentsDocument = exports.GetLedgerAgentDocument = exports.ListLedgerAccountsDocument = exports.GetLedgerAccountTreeDocument = exports.GetLedgerAccountRollupsDocument = exports.GetInvestorSecurityDocument = exports.ListInvestorSecuritiesDocument = exports.ListInvestorPositionsDocument = exports.GetInvestorPositionDocument = exports.ListInvestorPortfoliosDocument = exports.GetInvestorPortfolioBlockDocument = exports.GetInvestorHoldingsDocument = void 0;
+exports.ListLibraryTaxonomiesDocument = exports.GetLibraryElementDocument = exports.SearchLibraryElementsDocument = exports.ListLibraryElementsDocument = exports.GetLibraryElementEquivalentsDocument = exports.GetLibraryElementClassificationsDocument = exports.GetLibraryElementArcsDocument = exports.ListLibraryTaxonomyArcsDocument = exports.ListLedgerUnmappedElementsDocument = exports.GetLedgerTrialBalanceDocument = exports.ListLedgerTransactionsDocument = exports.GetLedgerTransactionDocument = exports.ListLedgerTaxonomiesDocument = exports.GetLedgerSummaryDocument = exports.ListLedgerStructuresDocument = exports.GetLedgerStatementDocument = exports.ListLedgerReportsDocument = exports.GetLedgerReportingTaxonomyDocument = exports.GetLedgerReportPackageDocument = exports.GetLedgerReportDocument = exports.ListLedgerPublishListsDocument = exports.GetLedgerPublishListDocument = exports.GetLedgerPeriodDraftsDocument = exports.GetLedgerPeriodCloseStatusDocument = exports.ListLedgerMappingsDocument = exports.GetLedgerMappingCoverageDocument = exports.MappingCandidatesDocument = exports.GetLedgerMappingDocument = exports.GetLedgerMappedTrialBalanceDocument = exports.ListInformationBlocksDocument = exports.GetInformationBlockDocument = exports.GetLedgerFiscalCalendarDocument = exports.ListLedgerEventBlocksDocument = exports.GetLedgerEventBlockDocument = exports.GetLedgerEntityDocument = exports.ListLedgerEntitiesDocument = exports.ListLedgerElementsDocument = exports.GetLedgerClosingBookStructuresDocument = exports.ListLedgerAgentsDocument = exports.GetLedgerAgentDocument = exports.ListLedgerAccountsDocument = exports.GetLedgerAccountTreeDocument = exports.GetLedgerAccountRollupsDocument = exports.GetInvestorSecurityDocument = exports.ListInvestorSecuritiesDocument = exports.ListInvestorPositionsDocument = exports.GetInvestorPositionDocument = exports.ListInvestorPortfoliosDocument = exports.GetInvestorPortfolioBlockDocument = exports.GetInvestorHoldingsDocument = void 0;
+exports.GetLibraryTaxonomyDocument = void 0;
 exports.GetInvestorHoldingsDocument = {
     kind: 'Document',
     definitions: [
@@ -1255,6 +1256,7 @@ exports.ListLedgerElementsDocument = {
                                             { kind: 'Field', name: { kind: 'Name', value: 'description' } },
                                             { kind: 'Field', name: { kind: 'Name', value: 'qname' } },
                                             { kind: 'Field', name: { kind: 'Name', value: 'namespace' } },
+                                            { kind: 'Field', name: { kind: 'Name', value: 'trait' } },
                                             { kind: 'Field', name: { kind: 'Name', value: 'subClassification' } },
                                             { kind: 'Field', name: { kind: 'Name', value: 'balanceType' } },
                                             { kind: 'Field', name: { kind: 'Name', value: 'periodType' } },
@@ -2399,6 +2401,51 @@ exports.GetLedgerMappingDocument = {
         },
     ],
 };
+exports.MappingCandidatesDocument = {
+    kind: 'Document',
+    definitions: [
+        {
+            kind: 'OperationDefinition',
+            operation: 'query',
+            name: { kind: 'Name', value: 'MappingCandidates' },
+            variableDefinitions: [
+                {
+                    kind: 'VariableDefinition',
+                    variable: { kind: 'Variable', name: { kind: 'Name', value: 'classification' } },
+                    type: {
+                        kind: 'NonNullType',
+                        type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
+                    },
+                },
+            ],
+            selectionSet: {
+                kind: 'SelectionSet',
+                selections: [
+                    {
+                        kind: 'Field',
+                        name: { kind: 'Name', value: 'mappingCandidates' },
+                        arguments: [
+                            {
+                                kind: 'Argument',
+                                name: { kind: 'Name', value: 'classification' },
+                                value: { kind: 'Variable', name: { kind: 'Name', value: 'classification' } },
+                            },
+                        ],
+                        selectionSet: {
+                            kind: 'SelectionSet',
+                            selections: [
+                                { kind: 'Field', name: { kind: 'Name', value: 'id' } },
+                                { kind: 'Field', name: { kind: 'Name', value: 'name' } },
+                                { kind: 'Field', name: { kind: 'Name', value: 'qname' } },
+                                { kind: 'Field', name: { kind: 'Name', value: 'trait' } },
+                            ],
+                        },
+                    },
+                ],
+            },
+        },
+    ],
+};
 exports.GetLedgerMappingCoverageDocument = {
     kind: 'Document',
     definitions: [

package/artifacts/graphql/generated/graphql.ts

@@ -1500,6 +1500,7 @@ export type Query = {
   libraryTaxonomyArcs: Array<LibraryAssociation>
   mappedTrialBalance: Maybe<MappedTrialBalance>
   mapping: Maybe<MappingDetail>
+  mappingCandidates: Array<Element>
   mappingCoverage: Maybe<MappingCoverage>
   mappings: Maybe<StructureList>
   openPayables: OpenBalanceAggregate
@@ -1685,6 +1686,10 @@ export type QueryMappingArgs = {
   mappingId: Scalars['String']['input']
 }
 
+export type QueryMappingCandidatesArgs = {
+  classification: Scalars['String']['input']
+}
+
 export type QueryMappingCoverageArgs = {
   mappingId: Scalars['String']['input']
 }
@@ -2592,6 +2597,7 @@ export type ListLedgerElementsQuery = {
       description: string | null
       qname: string | null
       namespace: string | null
+      trait: string | null
       subClassification: string | null
       balanceType: string
       periodType: string
@@ -3070,6 +3076,14 @@ export type GetLedgerMappingQuery = {
   } | null
 }
 
+export type MappingCandidatesQueryVariables = Exact<{
+  classification: Scalars['String']['input']
+}>
+
+export type MappingCandidatesQuery = {
+  mappingCandidates: Array<{ id: string; name: string; qname: string | null; trait: string | null }>
+}
+
 export type GetLedgerMappingCoverageQueryVariables = Exact<{
   mappingId: Scalars['String']['input']
 }>
@@ -5097,6 +5111,7 @@ export const ListLedgerElementsDocument = {
                       { kind: 'Field', name: { kind: 'Name', value: 'description' } },
                       { kind: 'Field', name: { kind: 'Name', value: 'qname' } },
                       { kind: 'Field', name: { kind: 'Name', value: 'namespace' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'trait' } },
                       { kind: 'Field', name: { kind: 'Name', value: 'subClassification' } },
                       { kind: 'Field', name: { kind: 'Name', value: 'balanceType' } },
                       { kind: 'Field', name: { kind: 'Name', value: 'periodType' } },
@@ -6244,6 +6259,51 @@ export const GetLedgerMappingDocument = {
     },
   ],
 } as unknown as DocumentNode<GetLedgerMappingQuery, GetLedgerMappingQueryVariables>
+export const MappingCandidatesDocument = {
+  kind: 'Document',
+  definitions: [
+    {
+      kind: 'OperationDefinition',
+      operation: 'query',
+      name: { kind: 'Name', value: 'MappingCandidates' },
+      variableDefinitions: [
+        {
+          kind: 'VariableDefinition',
+          variable: { kind: 'Variable', name: { kind: 'Name', value: 'classification' } },
+          type: {
+            kind: 'NonNullType',
+            type: { kind: 'NamedType', name: { kind: 'Name', value: 'String' } },
+          },
+        },
+      ],
+      selectionSet: {
+        kind: 'SelectionSet',
+        selections: [
+          {
+            kind: 'Field',
+            name: { kind: 'Name', value: 'mappingCandidates' },
+            arguments: [
+              {
+                kind: 'Argument',
+                name: { kind: 'Name', value: 'classification' },
+                value: { kind: 'Variable', name: { kind: 'Name', value: 'classification' } },
+              },
+            ],
+            selectionSet: {
+              kind: 'SelectionSet',
+              selections: [
+                { kind: 'Field', name: { kind: 'Name', value: 'id' } },
+                { kind: 'Field', name: { kind: 'Name', value: 'name' } },
+                { kind: 'Field', name: { kind: 'Name', value: 'qname' } },
+                { kind: 'Field', name: { kind: 'Name', value: 'trait' } },
+              ],
+            },
+          },
+        ],
+      },
+    },
+  ],
+} as unknown as DocumentNode<MappingCandidatesQuery, MappingCandidatesQueryVariables>
 export const GetLedgerMappingCoverageDocument = {
   kind: 'Document',
   definitions: [

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

@@ -31,6 +31,7 @@ exports.LIST_ELEMENTS = (0, graphql_request_1.gql) `
         description
         qname
         namespace
+        trait
         subClassification
         balanceType
         periodType

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

@@ -29,6 +29,7 @@ export const LIST_ELEMENTS = gql`
         description
         qname
         namespace
+        trait
         subClassification
         balanceType
         periodType