@robosystems/client 2.2.5 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -432,7 +432,10 @@ export declare class LedgerClient {
432
432
  taxonomyId?: string;
433
433
  blockType?: string;
434
434
  }): Promise<LedgerStructure[]>;
435
- /** List active CoA→reporting mapping structures. */
435
+ /**
436
+ * List active CoA→reporting mapping structures, the book mapping first.
437
+ * Each carries `framework`: the reporting framework it maps the chart into.
438
+ */
436
439
  listMappings(graphId: string): Promise<LedgerMappingInfo[]>;
437
440
  /** Get a mapping structure with all its associations. */
438
441
  getMapping(graphId: string, mappingId: string): Promise<LedgerMapping | null>;
@@ -255,7 +255,10 @@ class LedgerClient {
255
255
  return list?.structures ?? [];
256
256
  }
257
257
  // ── Mappings ────────────────────────────────────────────────────────
258
- /** List active CoA→reporting mapping structures. */
258
+ /**
259
+ * List active CoA→reporting mapping structures, the book mapping first.
260
+ * Each carries `framework`: the reporting framework it maps the chart into.
261
+ */
259
262
  async listMappings(graphId) {
260
263
  const list = await this.gqlQuery(graphId, graphql_1.ListLedgerMappingsDocument, undefined, 'List mappings', (data) => data.mappings);
261
264
  return list?.structures ?? [];
@@ -1164,7 +1164,10 @@ export class LedgerClient {
1164
1164
 
1165
1165
  // ── Mappings ────────────────────────────────────────────────────────
1166
1166
 
1167
- /** List active CoA→reporting mapping structures. */
1167
+ /**
1168
+ * List active CoA→reporting mapping structures, the book mapping first.
1169
+ * Each carries `framework`: the reporting framework it maps the chart into.
1170
+ */
1168
1171
  async listMappings(graphId: string): Promise<LedgerMappingInfo[]> {
1169
1172
  const list = await this.gqlQuery(
1170
1173
  graphId,
@@ -1257,6 +1257,7 @@ export type ListLedgerMappingsQuery = {
1257
1257
  blockType: string;
1258
1258
  taxonomyId: string;
1259
1259
  isActive: boolean;
1260
+ framework: string | null;
1260
1261
  }>;
1261
1262
  } | null;
1262
1263
  };
@@ -1697,6 +1698,7 @@ export type ListLedgerStructuresQuery = {
1697
1698
  blockType: string;
1698
1699
  taxonomyId: string;
1699
1700
  isActive: boolean;
1701
+ framework: string | null;
1700
1702
  }>;
1701
1703
  } | null;
1702
1704
  };
@@ -3336,6 +3336,7 @@ exports.ListLedgerMappingsDocument = {
3336
3336
  { kind: 'Field', name: { kind: 'Name', value: 'blockType' } },
3337
3337
  { kind: 'Field', name: { kind: 'Name', value: 'taxonomyId' } },
3338
3338
  { kind: 'Field', name: { kind: 'Name', value: 'isActive' } },
3339
+ { kind: 'Field', name: { kind: 'Name', value: 'framework' } },
3339
3340
  ],
3340
3341
  },
3341
3342
  },
@@ -4559,6 +4560,7 @@ exports.ListLedgerStructuresDocument = {
4559
4560
  { kind: 'Field', name: { kind: 'Name', value: 'blockType' } },
4560
4561
  { kind: 'Field', name: { kind: 'Name', value: 'taxonomyId' } },
4561
4562
  { kind: 'Field', name: { kind: 'Name', value: 'isActive' } },
4563
+ { kind: 'Field', name: { kind: 'Name', value: 'framework' } },
4562
4564
  ],
4563
4565
  },
4564
4566
  },
@@ -1214,6 +1214,7 @@ export type ListLedgerMappingsQuery = {
1214
1214
  blockType: string
1215
1215
  taxonomyId: string
1216
1216
  isActive: boolean
1217
+ framework: string | null
1217
1218
  }>
1218
1219
  } | null
1219
1220
  }
@@ -1636,6 +1637,7 @@ export type ListLedgerStructuresQuery = {
1636
1637
  blockType: string
1637
1638
  taxonomyId: string
1638
1639
  isActive: boolean
1640
+ framework: string | null
1639
1641
  }>
1640
1642
  } | null
1641
1643
  }
@@ -5382,6 +5384,7 @@ export const ListLedgerMappingsDocument = {
5382
5384
  { kind: 'Field', name: { kind: 'Name', value: 'blockType' } },
5383
5385
  { kind: 'Field', name: { kind: 'Name', value: 'taxonomyId' } },
5384
5386
  { kind: 'Field', name: { kind: 'Name', value: 'isActive' } },
5387
+ { kind: 'Field', name: { kind: 'Name', value: 'framework' } },
5385
5388
  ],
5386
5389
  },
5387
5390
  },
@@ -6614,6 +6617,7 @@ export const ListLedgerStructuresDocument = {
6614
6617
  { kind: 'Field', name: { kind: 'Name', value: 'blockType' } },
6615
6618
  { kind: 'Field', name: { kind: 'Name', value: 'taxonomyId' } },
6616
6619
  { kind: 'Field', name: { kind: 'Name', value: 'isActive' } },
6620
+ { kind: 'Field', name: { kind: 'Name', value: 'framework' } },
6617
6621
  ],
6618
6622
  },
6619
6623
  },
@@ -1,6 +1,7 @@
1
1
  /**
2
- * All active coa_mapping structures. Returned as a StructureList (same
3
- * wire shape as `structures`, just filtered server-side to
4
- * `block_type = 'coa_mapping'`).
2
+ * All active coa_mapping structures, the book mapping first. Returned as a
3
+ * StructureList (same wire shape as `structures`, just filtered server-side
4
+ * to `block_type = 'coa_mapping'`). `framework` is the reporting framework
5
+ * each maps the chart into; a chart holds one mapping per framework.
5
6
  */
6
7
  export declare const LIST_MAPPINGS: string;
@@ -3,9 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.LIST_MAPPINGS = void 0;
4
4
  const graphql_request_1 = require("graphql-request");
5
5
  /**
6
- * All active coa_mapping structures. Returned as a StructureList (same
7
- * wire shape as `structures`, just filtered server-side to
8
- * `block_type = 'coa_mapping'`).
6
+ * All active coa_mapping structures, the book mapping first. Returned as a
7
+ * StructureList (same wire shape as `structures`, just filtered server-side
8
+ * to `block_type = 'coa_mapping'`). `framework` is the reporting framework
9
+ * each maps the chart into; a chart holds one mapping per framework.
9
10
  */
10
11
  exports.LIST_MAPPINGS = (0, graphql_request_1.gql) `
11
12
  query ListLedgerMappings {
@@ -17,6 +18,7 @@ exports.LIST_MAPPINGS = (0, graphql_request_1.gql) `
17
18
  blockType
18
19
  taxonomyId
19
20
  isActive
21
+ framework
20
22
  }
21
23
  }
22
24
  }
@@ -1,9 +1,10 @@
1
1
  import { gql } from 'graphql-request'
2
2
 
3
3
  /**
4
- * All active coa_mapping structures. Returned as a StructureList (same
5
- * wire shape as `structures`, just filtered server-side to
6
- * `block_type = 'coa_mapping'`).
4
+ * All active coa_mapping structures, the book mapping first. Returned as a
5
+ * StructureList (same wire shape as `structures`, just filtered server-side
6
+ * to `block_type = 'coa_mapping'`). `framework` is the reporting framework
7
+ * each maps the chart into; a chart holds one mapping per framework.
7
8
  */
8
9
  export const LIST_MAPPINGS = gql`
9
10
  query ListLedgerMappings {
@@ -15,6 +16,7 @@ export const LIST_MAPPINGS = gql`
15
16
  blockType
16
17
  taxonomyId
17
18
  isActive
19
+ framework
18
20
  }
19
21
  }
20
22
  }
@@ -16,6 +16,7 @@ exports.LIST_STRUCTURES = (0, graphql_request_1.gql) `
16
16
  blockType
17
17
  taxonomyId
18
18
  isActive
19
+ framework
19
20
  }
20
21
  }
21
22
  }
@@ -14,6 +14,7 @@ export const LIST_STRUCTURES = gql`
14
14
  blockType
15
15
  taxonomyId
16
16
  isActive
17
+ framework
17
18
  }
18
19
  }
19
20
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@robosystems/client",
3
- "version": "2.2.5",
3
+ "version": "2.3.0",
4
4
  "description": "TypeScript client library for the RoboSystems financial intelligence platform",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
@@ -16606,6 +16606,12 @@ export type TaxonomyBlockStructure = {
16606
16606
  * Role Uri
16607
16607
  */
16608
16608
  role_uri?: string | null;
16609
+ /**
16610
+ * Target Framework
16611
+ *
16612
+ * `coa_mapping` only: the framework the mapping maps into.
16613
+ */
16614
+ target_framework?: string | null;
16609
16615
  };
16610
16616
  /**
16611
16617
  * TaxonomyBlockStructureRequest
@@ -16639,6 +16645,12 @@ export type TaxonomyBlockStructureRequest = {
16639
16645
  * Role Uri
16640
16646
  */
16641
16647
  role_uri?: string | null;
16648
+ /**
16649
+ * Target Framework
16650
+ *
16651
+ * `coa_mapping` only: the framework this mapping maps the chart into, e.g. `rs-gaap`. Omitted means the graph's book framework. A chart holds one mapping per framework.
16652
+ */
16653
+ target_framework?: string | null;
16642
16654
  /**
16643
16655
  * Metadata
16644
16656
  */
package/sdk/types.gen.ts CHANGED
@@ -17014,6 +17014,12 @@ export type TaxonomyBlockStructure = {
17014
17014
  * Role Uri
17015
17015
  */
17016
17016
  role_uri?: string | null;
17017
+ /**
17018
+ * Target Framework
17019
+ *
17020
+ * `coa_mapping` only: the framework the mapping maps into.
17021
+ */
17022
+ target_framework?: string | null;
17017
17023
  };
17018
17024
 
17019
17025
  /**
@@ -17048,6 +17054,12 @@ export type TaxonomyBlockStructureRequest = {
17048
17054
  * Role Uri
17049
17055
  */
17050
17056
  role_uri?: string | null;
17057
+ /**
17058
+ * Target Framework
17059
+ *
17060
+ * `coa_mapping` only: the framework this mapping maps the chart into, e.g. `rs-gaap`. Omitted means the graph's book framework. A chart holds one mapping per framework.
17061
+ */
17062
+ target_framework?: string | null;
17051
17063
  /**
17052
17064
  * Metadata
17053
17065
  */
package/types.gen.d.ts CHANGED
@@ -16606,6 +16606,12 @@ export type TaxonomyBlockStructure = {
16606
16606
  * Role Uri
16607
16607
  */
16608
16608
  role_uri?: string | null;
16609
+ /**
16610
+ * Target Framework
16611
+ *
16612
+ * `coa_mapping` only: the framework the mapping maps into.
16613
+ */
16614
+ target_framework?: string | null;
16609
16615
  };
16610
16616
  /**
16611
16617
  * TaxonomyBlockStructureRequest
@@ -16639,6 +16645,12 @@ export type TaxonomyBlockStructureRequest = {
16639
16645
  * Role Uri
16640
16646
  */
16641
16647
  role_uri?: string | null;
16648
+ /**
16649
+ * Target Framework
16650
+ *
16651
+ * `coa_mapping` only: the framework this mapping maps the chart into, e.g. `rs-gaap`. Omitted means the graph's book framework. A chart holds one mapping per framework.
16652
+ */
16653
+ target_framework?: string | null;
16642
16654
  /**
16643
16655
  * Metadata
16644
16656
  */
package/types.gen.ts CHANGED
@@ -17014,6 +17014,12 @@ export type TaxonomyBlockStructure = {
17014
17014
  * Role Uri
17015
17015
  */
17016
17016
  role_uri?: string | null;
17017
+ /**
17018
+ * Target Framework
17019
+ *
17020
+ * `coa_mapping` only: the framework the mapping maps into.
17021
+ */
17022
+ target_framework?: string | null;
17017
17023
  };
17018
17024
 
17019
17025
  /**
@@ -17048,6 +17054,12 @@ export type TaxonomyBlockStructureRequest = {
17048
17054
  * Role Uri
17049
17055
  */
17050
17056
  role_uri?: string | null;
17057
+ /**
17058
+ * Target Framework
17059
+ *
17060
+ * `coa_mapping` only: the framework this mapping maps the chart into, e.g. `rs-gaap`. Omitted means the graph's book framework. A chart holds one mapping per framework.
17061
+ */
17062
+ target_framework?: string | null;
17051
17063
  /**
17052
17064
  * Metadata
17053
17065
  */