@robosystems/client 1.7.0 → 1.8.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.
- package/README.md +10 -0
- package/artifacts/LedgerClient.d.ts +45 -2
- package/artifacts/LedgerClient.js +73 -0
- package/artifacts/LedgerClient.ts +119 -0
- package/artifacts/graphql/generated/graphql.d.ts +50 -0
- package/artifacts/graphql/generated/graphql.js +86 -2
- package/artifacts/graphql/generated/graphql.ts +136 -0
- package/artifacts/graphql/queries/ledger/blockedSourceGraphs.d.ts +9 -0
- package/artifacts/graphql/queries/ledger/blockedSourceGraphs.js +32 -0
- package/artifacts/graphql/queries/ledger/blockedSourceGraphs.ts +30 -0
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +7 -4
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +27 -3
- package/sdk/sdk.gen.js +54 -3
- package/sdk/sdk.gen.ts +54 -3
- package/sdk/types.gen.d.ts +466 -16
- package/sdk/types.gen.ts +490 -16
- package/sdk.gen.d.ts +27 -3
- package/sdk.gen.js +54 -3
- package/sdk.gen.ts +54 -3
- package/types.gen.d.ts +466 -16
- package/types.gen.ts +490 -16
package/README.md
CHANGED
|
@@ -21,6 +21,16 @@ Official TypeScript Client for the RoboSystems Financial Knowledge Graph API. Ac
|
|
|
21
21
|
npm install @robosystems/client
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
+
## Versioning
|
|
25
|
+
|
|
26
|
+
This client is `1.x` and follows semantic versioning, with one distinction worth knowing before you pin.
|
|
27
|
+
|
|
28
|
+
The **stable surface** is the facade clients and their subpath exports (`/clients`, `/ledger`, `/investor`, `/library`, `/query`, `/operations`, `/client`), the React hooks, the error classes, the auth configuration, and the types those signatures expose through `/types`. It is frozen for the life of `1.x`; breaking any of it costs a major version.
|
|
29
|
+
|
|
30
|
+
The **generated surface** — `/sdk`, which publishes the code generated from the platform's OpenAPI spec — tracks that spec. Operations there can be added, renamed, or removed on a minor release, and every such removal is named in that release's notes. `/sdk` is exported for convenience, not promised; anything that earns a compatibility promise is surfaced through a facade first.
|
|
31
|
+
|
|
32
|
+
So `^1` is the right pin if you build on the facades. If you import from `/sdk`, either pin a minor range (`~1.7`) and read the release notes when you widen, or open an issue to have the operation surfaced through a facade.
|
|
33
|
+
|
|
24
34
|
## Resources
|
|
25
35
|
|
|
26
36
|
- [RoboSystems Platform](https://robosystems.ai)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type { AssociationResponse, AutoMapElementsOperation, BindTextBlockRequest, BindTextBlockResponse, ComputeMetricsRequest, ComputeMetricsResponse, CreateAgentRequest, CreateEventBlockRequest, CreateEventHandlerRequest, CreateInformationBlockRequest, CreateMappingAssociationOperation, CreateTaxonomyBlockRequest, CreateViewRequest, DeleteInformationBlockRequest, DeleteInformationBlockResponse, DeleteMappingAssociationOperation, DeleteResult, DeleteTaxonomyBlockRequest, DeleteTaxonomyBlockResponse, EntityTaxonomyResponse, EvaluateRulesRequest, EvaluateRulesResponse, EventBlockEnvelope, EventHandlerResponse, FinancialStatementAnalysisRequest, FinancialStatementAnalysisResponse, InformationBlockEnvelope, JournalEntryResponse, LedgerAgentResponse, LinkEntityTaxonomyRequest, LiveFinancialStatementRequest, LiveFinancialStatementResponse, OperationEnvelope, PreviewEventBlockResponse, PublishListMemberResponse, PublishListResponse, ReportResponse, ShareReportResponse, TaxonomyBlockEnvelope, UpdateAgentRequest, UpdateEntityRequest, UpdateEventBlockRequest, UpdateEventHandlerRequest, UpdateInformationBlockRequest, UpdateJournalEntryRequest, UpdateTaxonomyBlockRequest, ViewResponse } from '../types.gen';
|
|
1
|
+
import type { AssociationResponse, AutoMapElementsOperation, BindTextBlockRequest, BindTextBlockResponse, BlockedSourceGraphResponse, BlockSourceGraphResult, ComputeMetricsRequest, ComputeMetricsResponse, CreateAgentRequest, CreateEventBlockRequest, CreateEventHandlerRequest, CreateInformationBlockRequest, CreateMappingAssociationOperation, CreateTaxonomyBlockRequest, CreateViewRequest, DeleteInformationBlockRequest, DeleteInformationBlockResponse, DeleteMappingAssociationOperation, DeleteResult, DeleteTaxonomyBlockRequest, DeleteTaxonomyBlockResponse, EntityTaxonomyResponse, EvaluateRulesRequest, EvaluateRulesResponse, EventBlockEnvelope, EventHandlerResponse, FinancialStatementAnalysisRequest, FinancialStatementAnalysisResponse, InformationBlockEnvelope, JournalEntryResponse, LedgerAgentResponse, LinkEntityTaxonomyRequest, LiveFinancialStatementRequest, LiveFinancialStatementResponse, OperationEnvelope, PreviewEventBlockResponse, PublishListMemberResponse, PublishListResponse, ReportResponse, RevokeReportShareResponse, ShareReportResponse, TaxonomyBlockEnvelope, UpdateAgentRequest, UpdateEntityRequest, UpdateEventBlockRequest, UpdateEventHandlerRequest, UpdateInformationBlockRequest, UpdateJournalEntryRequest, UpdateTaxonomyBlockRequest, ViewResponse } from '../types.gen';
|
|
2
2
|
import type { TokenProvider } from './graphql/client';
|
|
3
|
-
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, type ReportDownloadFormat } from './graphql/generated/graphql';
|
|
3
|
+
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 ListLedgerBlockedSourceGraphsQuery, type ListLedgerElementsQuery, type ListLedgerEntitiesQuery, type ListLedgerEventBlocksQuery, type ListLedgerMappingsQuery, type ListLedgerPublishListsQuery, type ListLedgerReportsQuery, type ListLedgerStructuresQuery, type ListLedgerTaxonomiesQuery, type ListLedgerTransactionsQuery, type ListLedgerUnmappedElementsQuery, type MappingCandidatesQuery, type ReportDownloadFormat } from './graphql/generated/graphql';
|
|
4
4
|
export { GraphQLError } from './graphql/client';
|
|
5
5
|
export type LedgerEntity = NonNullable<GetLedgerEntityQuery['entity']>;
|
|
6
6
|
export type LedgerEntitySummary = ListLedgerEntitiesQuery['entities'][number];
|
|
@@ -54,6 +54,7 @@ export type StatementRow = StatementData['rows'][number];
|
|
|
54
54
|
export type PublishList = NonNullable<ListLedgerPublishListsQuery['publishLists']>['publishLists'][number];
|
|
55
55
|
export type PublishListDetail = NonNullable<GetLedgerPublishListQuery['publishList']>;
|
|
56
56
|
export type PublishListMember = PublishListDetail['members'][number];
|
|
57
|
+
export type BlockedSourceGraph = NonNullable<ListLedgerBlockedSourceGraphsQuery['blockedSourceGraphs']>['blockedSourceGraphs'][number];
|
|
57
58
|
/**
|
|
58
59
|
* Presigned-URL response for a Report bundle download.
|
|
59
60
|
*
|
|
@@ -723,6 +724,48 @@ export declare class LedgerClient {
|
|
|
723
724
|
transitionFilingStatus(graphId: string, reportId: string, targetStatus: string): Promise<ReportResponse>;
|
|
724
725
|
/** Check if a report was received via sharing (vs locally created). */
|
|
725
726
|
isSharedReport(report: Report): boolean;
|
|
727
|
+
/**
|
|
728
|
+
* Withdraw a report previously shared to one recipient graph.
|
|
729
|
+
*
|
|
730
|
+
* The sender's half of the share controls: deletes the copy from that
|
|
731
|
+
* recipient's schema and marks the share revoked. Scoped to a single
|
|
732
|
+
* recipient, so withdrawing a distribution to a whole publish list is
|
|
733
|
+
* one call per member.
|
|
734
|
+
*
|
|
735
|
+
* A recipient who already deleted the copy themselves is not an error —
|
|
736
|
+
* the share is still marked revoked and `copyDeleted` comes back false.
|
|
737
|
+
* The linked entity in the recipient's graph is left in place, so an
|
|
738
|
+
* investor's declared holding survives the withdrawal.
|
|
739
|
+
*/
|
|
740
|
+
revokeReportShare(graphId: string, reportId: string, targetGraphId: string): Promise<RevokeReportShareResponse>;
|
|
741
|
+
/** List source graphs barred from sharing reports into this graph. */
|
|
742
|
+
listBlockedSourceGraphs(graphId: string, options?: {
|
|
743
|
+
limit?: number;
|
|
744
|
+
offset?: number;
|
|
745
|
+
}): Promise<BlockedSourceGraph[]>;
|
|
746
|
+
/**
|
|
747
|
+
* Bar a graph from sharing reports into this one.
|
|
748
|
+
*
|
|
749
|
+
* Read the sender's id off the `sourceGraphId` provenance field of a
|
|
750
|
+
* report that was shared to you. Blocking is idempotent: re-blocking
|
|
751
|
+
* returns `alreadyBlocked: true` and preserves the original `blockedAt`.
|
|
752
|
+
*
|
|
753
|
+
* With `purge`, every report already shared in from that source is
|
|
754
|
+
* deleted along with its fact sets and facts; reports this graph
|
|
755
|
+
* authored are never touched. `reason` is a note for your own records
|
|
756
|
+
* and is never disclosed to the sender.
|
|
757
|
+
*/
|
|
758
|
+
blockSourceGraph(graphId: string, sourceGraphId: string, options?: {
|
|
759
|
+
reason?: string;
|
|
760
|
+
purge?: boolean;
|
|
761
|
+
}): Promise<BlockSourceGraphResult>;
|
|
762
|
+
/**
|
|
763
|
+
* Lift a block, allowing that source to share in again.
|
|
764
|
+
*
|
|
765
|
+
* Reports removed by an earlier purge are not restored — unblocking
|
|
766
|
+
* reopens the channel, it does not undo.
|
|
767
|
+
*/
|
|
768
|
+
unblockSourceGraph(graphId: string, sourceGraphId: string): Promise<BlockedSourceGraphResponse>;
|
|
726
769
|
/** List publish lists with pagination. */
|
|
727
770
|
listPublishLists(graphId: string, options?: {
|
|
728
771
|
limit?: number;
|
|
@@ -960,6 +960,79 @@ class LedgerClient {
|
|
|
960
960
|
isSharedReport(report) {
|
|
961
961
|
return report.sourceGraphId !== null;
|
|
962
962
|
}
|
|
963
|
+
/**
|
|
964
|
+
* Withdraw a report previously shared to one recipient graph.
|
|
965
|
+
*
|
|
966
|
+
* The sender's half of the share controls: deletes the copy from that
|
|
967
|
+
* recipient's schema and marks the share revoked. Scoped to a single
|
|
968
|
+
* recipient, so withdrawing a distribution to a whole publish list is
|
|
969
|
+
* one call per member.
|
|
970
|
+
*
|
|
971
|
+
* A recipient who already deleted the copy themselves is not an error —
|
|
972
|
+
* the share is still marked revoked and `copyDeleted` comes back false.
|
|
973
|
+
* The linked entity in the recipient's graph is left in place, so an
|
|
974
|
+
* investor's declared holding survives the withdrawal.
|
|
975
|
+
*/
|
|
976
|
+
async revokeReportShare(graphId, reportId, targetGraphId) {
|
|
977
|
+
const envelope = await this.callOperation('Revoke report share', (0, sdk_gen_1.revokeReportShare)({
|
|
978
|
+
path: { graph_id: graphId },
|
|
979
|
+
body: {
|
|
980
|
+
report_id: reportId,
|
|
981
|
+
target_graph_id: targetGraphId,
|
|
982
|
+
},
|
|
983
|
+
}));
|
|
984
|
+
return this.requireResult('Revoke report share', envelope.result);
|
|
985
|
+
}
|
|
986
|
+
// ── Blocked source graphs ────────────────────────────────────────────
|
|
987
|
+
//
|
|
988
|
+
// Sharing is authorized capability-style — whoever holds this graph's id
|
|
989
|
+
// can copy a published report into it — so these are the recipient's exit.
|
|
990
|
+
/** List source graphs barred from sharing reports into this graph. */
|
|
991
|
+
async listBlockedSourceGraphs(graphId, options) {
|
|
992
|
+
const list = await this.gqlQuery(graphId, graphql_1.ListLedgerBlockedSourceGraphsDocument, {
|
|
993
|
+
limit: options?.limit ?? 100,
|
|
994
|
+
offset: options?.offset ?? 0,
|
|
995
|
+
}, 'List blocked source graphs', (data) => data.blockedSourceGraphs);
|
|
996
|
+
return list?.blockedSourceGraphs ?? [];
|
|
997
|
+
}
|
|
998
|
+
/**
|
|
999
|
+
* Bar a graph from sharing reports into this one.
|
|
1000
|
+
*
|
|
1001
|
+
* Read the sender's id off the `sourceGraphId` provenance field of a
|
|
1002
|
+
* report that was shared to you. Blocking is idempotent: re-blocking
|
|
1003
|
+
* returns `alreadyBlocked: true` and preserves the original `blockedAt`.
|
|
1004
|
+
*
|
|
1005
|
+
* With `purge`, every report already shared in from that source is
|
|
1006
|
+
* deleted along with its fact sets and facts; reports this graph
|
|
1007
|
+
* authored are never touched. `reason` is a note for your own records
|
|
1008
|
+
* and is never disclosed to the sender.
|
|
1009
|
+
*/
|
|
1010
|
+
async blockSourceGraph(graphId, sourceGraphId, options) {
|
|
1011
|
+
const envelope = await this.callOperation('Block source graph', (0, sdk_gen_1.blockSourceGraph)({
|
|
1012
|
+
path: { graph_id: graphId },
|
|
1013
|
+
body: {
|
|
1014
|
+
source_graph_id: sourceGraphId,
|
|
1015
|
+
...(options?.reason !== undefined ? { reason: options.reason } : {}),
|
|
1016
|
+
purge: options?.purge ?? false,
|
|
1017
|
+
},
|
|
1018
|
+
}));
|
|
1019
|
+
return this.requireResult('Block source graph', envelope.result);
|
|
1020
|
+
}
|
|
1021
|
+
/**
|
|
1022
|
+
* Lift a block, allowing that source to share in again.
|
|
1023
|
+
*
|
|
1024
|
+
* Reports removed by an earlier purge are not restored — unblocking
|
|
1025
|
+
* reopens the channel, it does not undo.
|
|
1026
|
+
*/
|
|
1027
|
+
async unblockSourceGraph(graphId, sourceGraphId) {
|
|
1028
|
+
const envelope = await this.callOperation('Unblock source graph', (0, sdk_gen_1.unblockSourceGraph)({
|
|
1029
|
+
path: { graph_id: graphId },
|
|
1030
|
+
body: {
|
|
1031
|
+
source_graph_id: sourceGraphId,
|
|
1032
|
+
},
|
|
1033
|
+
}));
|
|
1034
|
+
return this.requireResult('Unblock source graph', envelope.result);
|
|
1035
|
+
}
|
|
963
1036
|
// ── Publish Lists ────────────────────────────────────────────────────
|
|
964
1037
|
/** List publish lists with pagination. */
|
|
965
1038
|
async listPublishLists(graphId, options) {
|
|
@@ -28,6 +28,7 @@ import {
|
|
|
28
28
|
addPublishListMembers,
|
|
29
29
|
autoMapElements,
|
|
30
30
|
bindTextBlock,
|
|
31
|
+
blockSourceGraph,
|
|
31
32
|
buildFactGrid,
|
|
32
33
|
closePeriod,
|
|
33
34
|
computeMetrics,
|
|
@@ -56,9 +57,11 @@ import {
|
|
|
56
57
|
regenerateReport,
|
|
57
58
|
removePublishListMember,
|
|
58
59
|
reopenPeriod,
|
|
60
|
+
revokeReportShare,
|
|
59
61
|
setCloseTarget,
|
|
60
62
|
shareReport,
|
|
61
63
|
transitionFilingStatus,
|
|
64
|
+
unblockSourceGraph,
|
|
62
65
|
updateAgent,
|
|
63
66
|
updateEntity,
|
|
64
67
|
updateEventBlock,
|
|
@@ -74,6 +77,8 @@ import type {
|
|
|
74
77
|
AutoMapElementsOperation,
|
|
75
78
|
BindTextBlockRequest,
|
|
76
79
|
BindTextBlockResponse,
|
|
80
|
+
BlockedSourceGraphResponse,
|
|
81
|
+
BlockSourceGraphResult,
|
|
77
82
|
ClosePeriodOperation,
|
|
78
83
|
ComputeMetricsRequest,
|
|
79
84
|
ComputeMetricsResponse,
|
|
@@ -116,6 +121,7 @@ import type {
|
|
|
116
121
|
RebuildScheduleRequest,
|
|
117
122
|
ReopenPeriodOperation,
|
|
118
123
|
ReportResponse,
|
|
124
|
+
RevokeReportShareResponse,
|
|
119
125
|
SetCloseTargetOperation,
|
|
120
126
|
ShareReportResponse,
|
|
121
127
|
TaxonomyBlockEnvelope,
|
|
@@ -159,6 +165,7 @@ import {
|
|
|
159
165
|
ListInformationBlocksDocument,
|
|
160
166
|
ListLedgerAccountsDocument,
|
|
161
167
|
ListLedgerAgentsDocument,
|
|
168
|
+
ListLedgerBlockedSourceGraphsDocument,
|
|
162
169
|
ListLedgerElementsDocument,
|
|
163
170
|
ListLedgerEntitiesDocument,
|
|
164
171
|
ListLedgerEventBlocksDocument,
|
|
@@ -194,6 +201,7 @@ import {
|
|
|
194
201
|
type ListInformationBlocksQuery,
|
|
195
202
|
type ListLedgerAccountsQuery,
|
|
196
203
|
type ListLedgerAgentsQuery,
|
|
204
|
+
type ListLedgerBlockedSourceGraphsQuery,
|
|
197
205
|
type ListLedgerElementsQuery,
|
|
198
206
|
type ListLedgerEntitiesQuery,
|
|
199
207
|
type ListLedgerEventBlocksQuery,
|
|
@@ -299,6 +307,10 @@ export type PublishList = NonNullable<
|
|
|
299
307
|
export type PublishListDetail = NonNullable<GetLedgerPublishListQuery['publishList']>
|
|
300
308
|
export type PublishListMember = PublishListDetail['members'][number]
|
|
301
309
|
|
|
310
|
+
export type BlockedSourceGraph = NonNullable<
|
|
311
|
+
ListLedgerBlockedSourceGraphsQuery['blockedSourceGraphs']
|
|
312
|
+
>['blockedSourceGraphs'][number]
|
|
313
|
+
|
|
302
314
|
/**
|
|
303
315
|
* Presigned-URL response for a Report bundle download.
|
|
304
316
|
*
|
|
@@ -2217,6 +2229,113 @@ export class LedgerClient {
|
|
|
2217
2229
|
return report.sourceGraphId !== null
|
|
2218
2230
|
}
|
|
2219
2231
|
|
|
2232
|
+
/**
|
|
2233
|
+
* Withdraw a report previously shared to one recipient graph.
|
|
2234
|
+
*
|
|
2235
|
+
* The sender's half of the share controls: deletes the copy from that
|
|
2236
|
+
* recipient's schema and marks the share revoked. Scoped to a single
|
|
2237
|
+
* recipient, so withdrawing a distribution to a whole publish list is
|
|
2238
|
+
* one call per member.
|
|
2239
|
+
*
|
|
2240
|
+
* A recipient who already deleted the copy themselves is not an error —
|
|
2241
|
+
* the share is still marked revoked and `copyDeleted` comes back false.
|
|
2242
|
+
* The linked entity in the recipient's graph is left in place, so an
|
|
2243
|
+
* investor's declared holding survives the withdrawal.
|
|
2244
|
+
*/
|
|
2245
|
+
async revokeReportShare(
|
|
2246
|
+
graphId: string,
|
|
2247
|
+
reportId: string,
|
|
2248
|
+
targetGraphId: string
|
|
2249
|
+
): Promise<RevokeReportShareResponse> {
|
|
2250
|
+
const envelope = await this.callOperation(
|
|
2251
|
+
'Revoke report share',
|
|
2252
|
+
revokeReportShare({
|
|
2253
|
+
path: { graph_id: graphId },
|
|
2254
|
+
body: {
|
|
2255
|
+
report_id: reportId,
|
|
2256
|
+
target_graph_id: targetGraphId,
|
|
2257
|
+
} as Parameters<typeof revokeReportShare>[0]['body'],
|
|
2258
|
+
})
|
|
2259
|
+
)
|
|
2260
|
+
return this.requireResult('Revoke report share', envelope.result)
|
|
2261
|
+
}
|
|
2262
|
+
|
|
2263
|
+
// ── Blocked source graphs ────────────────────────────────────────────
|
|
2264
|
+
//
|
|
2265
|
+
// Sharing is authorized capability-style — whoever holds this graph's id
|
|
2266
|
+
// can copy a published report into it — so these are the recipient's exit.
|
|
2267
|
+
|
|
2268
|
+
/** List source graphs barred from sharing reports into this graph. */
|
|
2269
|
+
async listBlockedSourceGraphs(
|
|
2270
|
+
graphId: string,
|
|
2271
|
+
options?: { limit?: number; offset?: number }
|
|
2272
|
+
): Promise<BlockedSourceGraph[]> {
|
|
2273
|
+
const list = await this.gqlQuery(
|
|
2274
|
+
graphId,
|
|
2275
|
+
ListLedgerBlockedSourceGraphsDocument,
|
|
2276
|
+
{
|
|
2277
|
+
limit: options?.limit ?? 100,
|
|
2278
|
+
offset: options?.offset ?? 0,
|
|
2279
|
+
},
|
|
2280
|
+
'List blocked source graphs',
|
|
2281
|
+
(data) => data.blockedSourceGraphs
|
|
2282
|
+
)
|
|
2283
|
+
return list?.blockedSourceGraphs ?? []
|
|
2284
|
+
}
|
|
2285
|
+
|
|
2286
|
+
/**
|
|
2287
|
+
* Bar a graph from sharing reports into this one.
|
|
2288
|
+
*
|
|
2289
|
+
* Read the sender's id off the `sourceGraphId` provenance field of a
|
|
2290
|
+
* report that was shared to you. Blocking is idempotent: re-blocking
|
|
2291
|
+
* returns `alreadyBlocked: true` and preserves the original `blockedAt`.
|
|
2292
|
+
*
|
|
2293
|
+
* With `purge`, every report already shared in from that source is
|
|
2294
|
+
* deleted along with its fact sets and facts; reports this graph
|
|
2295
|
+
* authored are never touched. `reason` is a note for your own records
|
|
2296
|
+
* and is never disclosed to the sender.
|
|
2297
|
+
*/
|
|
2298
|
+
async blockSourceGraph(
|
|
2299
|
+
graphId: string,
|
|
2300
|
+
sourceGraphId: string,
|
|
2301
|
+
options?: { reason?: string; purge?: boolean }
|
|
2302
|
+
): Promise<BlockSourceGraphResult> {
|
|
2303
|
+
const envelope = await this.callOperation(
|
|
2304
|
+
'Block source graph',
|
|
2305
|
+
blockSourceGraph({
|
|
2306
|
+
path: { graph_id: graphId },
|
|
2307
|
+
body: {
|
|
2308
|
+
source_graph_id: sourceGraphId,
|
|
2309
|
+
...(options?.reason !== undefined ? { reason: options.reason } : {}),
|
|
2310
|
+
purge: options?.purge ?? false,
|
|
2311
|
+
} as Parameters<typeof blockSourceGraph>[0]['body'],
|
|
2312
|
+
})
|
|
2313
|
+
)
|
|
2314
|
+
return this.requireResult('Block source graph', envelope.result)
|
|
2315
|
+
}
|
|
2316
|
+
|
|
2317
|
+
/**
|
|
2318
|
+
* Lift a block, allowing that source to share in again.
|
|
2319
|
+
*
|
|
2320
|
+
* Reports removed by an earlier purge are not restored — unblocking
|
|
2321
|
+
* reopens the channel, it does not undo.
|
|
2322
|
+
*/
|
|
2323
|
+
async unblockSourceGraph(
|
|
2324
|
+
graphId: string,
|
|
2325
|
+
sourceGraphId: string
|
|
2326
|
+
): Promise<BlockedSourceGraphResponse> {
|
|
2327
|
+
const envelope = await this.callOperation(
|
|
2328
|
+
'Unblock source graph',
|
|
2329
|
+
unblockSourceGraph({
|
|
2330
|
+
path: { graph_id: graphId },
|
|
2331
|
+
body: {
|
|
2332
|
+
source_graph_id: sourceGraphId,
|
|
2333
|
+
} as Parameters<typeof unblockSourceGraph>[0]['body'],
|
|
2334
|
+
})
|
|
2335
|
+
)
|
|
2336
|
+
return this.requireResult('Unblock source graph', envelope.result)
|
|
2337
|
+
}
|
|
2338
|
+
|
|
2220
2339
|
// ── Publish Lists ────────────────────────────────────────────────────
|
|
2221
2340
|
|
|
2222
2341
|
/** List publish lists with pagination. */
|
|
@@ -192,6 +192,28 @@ export type Association = {
|
|
|
192
192
|
toElementQname: Maybe<Scalars['String']['output']>;
|
|
193
193
|
weight: Maybe<Scalars['Float']['output']>;
|
|
194
194
|
};
|
|
195
|
+
/** One blocked source graph. */
|
|
196
|
+
export type BlockedSourceGraph = {
|
|
197
|
+
/** When the block was created. */
|
|
198
|
+
blockedAt: Scalars['DateTime']['output'];
|
|
199
|
+
/** User ID that created the block. */
|
|
200
|
+
blockedBy: Scalars['String']['output'];
|
|
201
|
+
/** Block row identifier (ULID). */
|
|
202
|
+
id: Scalars['String']['output'];
|
|
203
|
+
/** Recipient's own note, if given. */
|
|
204
|
+
reason: Maybe<Scalars['String']['output']>;
|
|
205
|
+
/** The blocked sender's graph ID. */
|
|
206
|
+
sourceGraphId: Scalars['String']['output'];
|
|
207
|
+
/** Display name of the blocked graph (if known). */
|
|
208
|
+
sourceGraphName: Maybe<Scalars['String']['output']>;
|
|
209
|
+
};
|
|
210
|
+
/** Paginated list of blocked source graphs. */
|
|
211
|
+
export type BlockedSourceGraphList = {
|
|
212
|
+
/** Blocked source graphs. */
|
|
213
|
+
blockedSourceGraphs: Array<BlockedSourceGraph>;
|
|
214
|
+
/** Pagination metadata. */
|
|
215
|
+
pagination: PaginationInfo;
|
|
216
|
+
};
|
|
195
217
|
/**
|
|
196
218
|
* A grouping of closing-book items shown as a sidebar section
|
|
197
219
|
* (e.g. Statements, Account Rollups, Schedules, Period Close).
|
|
@@ -1516,6 +1538,7 @@ export type Query = {
|
|
|
1516
1538
|
accounts: Maybe<AccountList>;
|
|
1517
1539
|
agent: Maybe<Agent>;
|
|
1518
1540
|
agents: Array<Agent>;
|
|
1541
|
+
blockedSourceGraphs: Maybe<BlockedSourceGraphList>;
|
|
1519
1542
|
closingBookStructures: Maybe<ClosingBookStructures>;
|
|
1520
1543
|
elements: Maybe<ElementList>;
|
|
1521
1544
|
entities: Array<LedgerEntity>;
|
|
@@ -1599,6 +1622,10 @@ export type QueryAgentsArgs = {
|
|
|
1599
1622
|
offset?: InputMaybe<Scalars['Int']['input']>;
|
|
1600
1623
|
source?: InputMaybe<Scalars['String']['input']>;
|
|
1601
1624
|
};
|
|
1625
|
+
export type QueryBlockedSourceGraphsArgs = {
|
|
1626
|
+
limit?: InputMaybe<Scalars['Int']['input']>;
|
|
1627
|
+
offset?: InputMaybe<Scalars['Int']['input']>;
|
|
1628
|
+
};
|
|
1602
1629
|
export type QueryElementsArgs = {
|
|
1603
1630
|
classification?: InputMaybe<Scalars['String']['input']>;
|
|
1604
1631
|
isAbstract?: InputMaybe<Scalars['Boolean']['input']>;
|
|
@@ -2568,6 +2595,28 @@ export type ListLedgerAgentsQuery = {
|
|
|
2568
2595
|
createdBy: string | null;
|
|
2569
2596
|
}>;
|
|
2570
2597
|
};
|
|
2598
|
+
export type ListLedgerBlockedSourceGraphsQueryVariables = Exact<{
|
|
2599
|
+
limit?: Scalars['Int']['input'];
|
|
2600
|
+
offset?: Scalars['Int']['input'];
|
|
2601
|
+
}>;
|
|
2602
|
+
export type ListLedgerBlockedSourceGraphsQuery = {
|
|
2603
|
+
blockedSourceGraphs: {
|
|
2604
|
+
blockedSourceGraphs: Array<{
|
|
2605
|
+
id: string;
|
|
2606
|
+
sourceGraphId: string;
|
|
2607
|
+
sourceGraphName: string | null;
|
|
2608
|
+
blockedBy: string;
|
|
2609
|
+
blockedAt: any;
|
|
2610
|
+
reason: string | null;
|
|
2611
|
+
}>;
|
|
2612
|
+
pagination: {
|
|
2613
|
+
total: number;
|
|
2614
|
+
limit: number;
|
|
2615
|
+
offset: number;
|
|
2616
|
+
hasMore: boolean;
|
|
2617
|
+
};
|
|
2618
|
+
} | null;
|
|
2619
|
+
};
|
|
2571
2620
|
export type GetLedgerClosingBookStructuresQueryVariables = Exact<{
|
|
2572
2621
|
[key: string]: never;
|
|
2573
2622
|
}>;
|
|
@@ -4210,6 +4259,7 @@ export declare const GetLedgerAccountTreeDocument: DocumentNode<GetLedgerAccount
|
|
|
4210
4259
|
export declare const ListLedgerAccountsDocument: DocumentNode<ListLedgerAccountsQuery, ListLedgerAccountsQueryVariables>;
|
|
4211
4260
|
export declare const GetLedgerAgentDocument: DocumentNode<GetLedgerAgentQuery, GetLedgerAgentQueryVariables>;
|
|
4212
4261
|
export declare const ListLedgerAgentsDocument: DocumentNode<ListLedgerAgentsQuery, ListLedgerAgentsQueryVariables>;
|
|
4262
|
+
export declare const ListLedgerBlockedSourceGraphsDocument: DocumentNode<ListLedgerBlockedSourceGraphsQuery, ListLedgerBlockedSourceGraphsQueryVariables>;
|
|
4213
4263
|
export declare const GetLedgerClosingBookStructuresDocument: DocumentNode<GetLedgerClosingBookStructuresQuery, GetLedgerClosingBookStructuresQueryVariables>;
|
|
4214
4264
|
export declare const ListLedgerElementsDocument: DocumentNode<ListLedgerElementsQuery, ListLedgerElementsQueryVariables>;
|
|
4215
4265
|
export declare const ListLedgerEntitiesDocument: DocumentNode<ListLedgerEntitiesQuery, ListLedgerEntitiesQueryVariables>;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
4
|
-
exports.GetLibraryTaxonomyDocument = exports.ListLibraryTaxonomiesDocument = exports.GetLibraryStructureDocument = exports.ListLibraryStructuresDocument = exports.GetLibraryElementDocument = void 0;
|
|
3
|
+
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.GetLedgerReportDownloadUrlDocument = exports.GetLedgerReportDocument = exports.ListLedgerPublishListsDocument = exports.GetLedgerPublishListDocument = exports.GetLedgerPeriodDraftsDocument = exports.GetLedgerPeriodCloseStatusDocument = exports.ListLedgerMappingsDocument = exports.GetLedgerMappingCoverageDocument = exports.MappingCandidatesDocument = exports.GetLedgerMappingDocument = exports.GetLedgerMappedTrialBalanceDocument = exports.ListInformationBlocksDocument = exports.GetInformationBlockWindowedDocument = exports.GetInformationBlockDocument = exports.GetLedgerFiscalCalendarDocument = exports.ListLedgerEventBlocksDocument = exports.GetLedgerEventBlockDocument = exports.GetLedgerEntityDocument = exports.ListLedgerEntitiesDocument = exports.ListLedgerElementsDocument = exports.GetLedgerClosingBookStructuresDocument = exports.ListLedgerBlockedSourceGraphsDocument = 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;
|
|
4
|
+
exports.GetLibraryTaxonomyDocument = exports.ListLibraryTaxonomiesDocument = exports.GetLibraryStructureDocument = exports.ListLibraryStructuresDocument = exports.GetLibraryElementDocument = exports.SearchLibraryElementsDocument = void 0;
|
|
5
5
|
exports.GetInvestorHoldingsDocument = {
|
|
6
6
|
kind: 'Document',
|
|
7
7
|
definitions: [
|
|
@@ -1106,6 +1106,90 @@ exports.ListLedgerAgentsDocument = {
|
|
|
1106
1106
|
},
|
|
1107
1107
|
],
|
|
1108
1108
|
};
|
|
1109
|
+
exports.ListLedgerBlockedSourceGraphsDocument = {
|
|
1110
|
+
kind: 'Document',
|
|
1111
|
+
definitions: [
|
|
1112
|
+
{
|
|
1113
|
+
kind: 'OperationDefinition',
|
|
1114
|
+
operation: 'query',
|
|
1115
|
+
name: { kind: 'Name', value: 'ListLedgerBlockedSourceGraphs' },
|
|
1116
|
+
variableDefinitions: [
|
|
1117
|
+
{
|
|
1118
|
+
kind: 'VariableDefinition',
|
|
1119
|
+
variable: { kind: 'Variable', name: { kind: 'Name', value: 'limit' } },
|
|
1120
|
+
type: {
|
|
1121
|
+
kind: 'NonNullType',
|
|
1122
|
+
type: { kind: 'NamedType', name: { kind: 'Name', value: 'Int' } },
|
|
1123
|
+
},
|
|
1124
|
+
defaultValue: { kind: 'IntValue', value: '100' },
|
|
1125
|
+
},
|
|
1126
|
+
{
|
|
1127
|
+
kind: 'VariableDefinition',
|
|
1128
|
+
variable: { kind: 'Variable', name: { kind: 'Name', value: 'offset' } },
|
|
1129
|
+
type: {
|
|
1130
|
+
kind: 'NonNullType',
|
|
1131
|
+
type: { kind: 'NamedType', name: { kind: 'Name', value: 'Int' } },
|
|
1132
|
+
},
|
|
1133
|
+
defaultValue: { kind: 'IntValue', value: '0' },
|
|
1134
|
+
},
|
|
1135
|
+
],
|
|
1136
|
+
selectionSet: {
|
|
1137
|
+
kind: 'SelectionSet',
|
|
1138
|
+
selections: [
|
|
1139
|
+
{
|
|
1140
|
+
kind: 'Field',
|
|
1141
|
+
name: { kind: 'Name', value: 'blockedSourceGraphs' },
|
|
1142
|
+
arguments: [
|
|
1143
|
+
{
|
|
1144
|
+
kind: 'Argument',
|
|
1145
|
+
name: { kind: 'Name', value: 'limit' },
|
|
1146
|
+
value: { kind: 'Variable', name: { kind: 'Name', value: 'limit' } },
|
|
1147
|
+
},
|
|
1148
|
+
{
|
|
1149
|
+
kind: 'Argument',
|
|
1150
|
+
name: { kind: 'Name', value: 'offset' },
|
|
1151
|
+
value: { kind: 'Variable', name: { kind: 'Name', value: 'offset' } },
|
|
1152
|
+
},
|
|
1153
|
+
],
|
|
1154
|
+
selectionSet: {
|
|
1155
|
+
kind: 'SelectionSet',
|
|
1156
|
+
selections: [
|
|
1157
|
+
{
|
|
1158
|
+
kind: 'Field',
|
|
1159
|
+
name: { kind: 'Name', value: 'blockedSourceGraphs' },
|
|
1160
|
+
selectionSet: {
|
|
1161
|
+
kind: 'SelectionSet',
|
|
1162
|
+
selections: [
|
|
1163
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'id' } },
|
|
1164
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'sourceGraphId' } },
|
|
1165
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'sourceGraphName' } },
|
|
1166
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'blockedBy' } },
|
|
1167
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'blockedAt' } },
|
|
1168
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'reason' } },
|
|
1169
|
+
],
|
|
1170
|
+
},
|
|
1171
|
+
},
|
|
1172
|
+
{
|
|
1173
|
+
kind: 'Field',
|
|
1174
|
+
name: { kind: 'Name', value: 'pagination' },
|
|
1175
|
+
selectionSet: {
|
|
1176
|
+
kind: 'SelectionSet',
|
|
1177
|
+
selections: [
|
|
1178
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'total' } },
|
|
1179
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'limit' } },
|
|
1180
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'offset' } },
|
|
1181
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'hasMore' } },
|
|
1182
|
+
],
|
|
1183
|
+
},
|
|
1184
|
+
},
|
|
1185
|
+
],
|
|
1186
|
+
},
|
|
1187
|
+
},
|
|
1188
|
+
],
|
|
1189
|
+
},
|
|
1190
|
+
},
|
|
1191
|
+
],
|
|
1192
|
+
};
|
|
1109
1193
|
exports.GetLedgerClosingBookStructuresDocument = {
|
|
1110
1194
|
kind: 'Document',
|
|
1111
1195
|
definitions: [
|