@robosystems/client 2.1.1 → 2.2.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.
@@ -75,7 +75,7 @@ export interface ReportBundleDownloadResponse {
75
75
  expiresAt: string;
76
76
  /** MIME type of the artifact behind the URL. */
77
77
  contentType: string;
78
- /** Serialization flavor — ``jsonld`` or ``xbrl-2.1``. */
78
+ /** Serialization flavor — ``tavi``, ``holon-jsonld`` or ``xbrl-2.1``. */
79
79
  format: string;
80
80
  /** Bundle generation number stamped on the Report. */
81
81
  generationCount: number;
@@ -761,8 +761,8 @@ export declare class LedgerClient {
761
761
  *
762
762
  * @param graphId Graph identifier owning the Report.
763
763
  * @param reportId Report identifier (rpt_-prefixed ULID).
764
- * @param options.format Serialization flavor — `JSONLD` (default), `HOLON_JSONLD`,
765
- * `XBRL_2_1`, or `TAVI` (the Project Tavi compiled model).
764
+ * @param options.format Serialization flavor — `TAVI` (default, the Project
765
+ * Tavi compiled model stamped at publish), `HOLON_JSONLD`, or `XBRL_2_1`.
766
766
  * @param options.expiresIn Presigned URL lifetime, in seconds.
767
767
  */
768
768
  getReportDownloadUrl(graphId: string, reportId: string, options?: {
@@ -950,14 +950,14 @@ class LedgerClient {
950
950
  *
951
951
  * @param graphId Graph identifier owning the Report.
952
952
  * @param reportId Report identifier (rpt_-prefixed ULID).
953
- * @param options.format Serialization flavor — `JSONLD` (default), `HOLON_JSONLD`,
954
- * `XBRL_2_1`, or `TAVI` (the Project Tavi compiled model).
953
+ * @param options.format Serialization flavor — `TAVI` (default, the Project
954
+ * Tavi compiled model stamped at publish), `HOLON_JSONLD`, or `XBRL_2_1`.
955
955
  * @param options.expiresIn Presigned URL lifetime, in seconds.
956
956
  */
957
957
  async getReportDownloadUrl(graphId, reportId, options = {}) {
958
958
  return this.gqlQuery(graphId, graphql_1.GetLedgerReportDownloadUrlDocument, {
959
959
  reportId,
960
- format: options.format ?? 'JSONLD',
960
+ format: options.format ?? 'TAVI',
961
961
  expiresIn: options.expiresIn ?? 300,
962
962
  }, 'Get report download URL', (data) => {
963
963
  const node = data.reportDownloadUrl;
@@ -339,7 +339,7 @@ export interface ReportBundleDownloadResponse {
339
339
  expiresAt: string
340
340
  /** MIME type of the artifact behind the URL. */
341
341
  contentType: string
342
- /** Serialization flavor — ``jsonld`` or ``xbrl-2.1``. */
342
+ /** Serialization flavor — ``tavi``, ``holon-jsonld`` or ``xbrl-2.1``. */
343
343
  format: string
344
344
  /** Bundle generation number stamped on the Report. */
345
345
  generationCount: number
@@ -2270,8 +2270,8 @@ export class LedgerClient {
2270
2270
  *
2271
2271
  * @param graphId Graph identifier owning the Report.
2272
2272
  * @param reportId Report identifier (rpt_-prefixed ULID).
2273
- * @param options.format Serialization flavor — `JSONLD` (default), `HOLON_JSONLD`,
2274
- * `XBRL_2_1`, or `TAVI` (the Project Tavi compiled model).
2273
+ * @param options.format Serialization flavor — `TAVI` (default, the Project
2274
+ * Tavi compiled model stamped at publish), `HOLON_JSONLD`, or `XBRL_2_1`.
2275
2275
  * @param options.expiresIn Presigned URL lifetime, in seconds.
2276
2276
  */
2277
2277
  async getReportDownloadUrl(
@@ -2284,7 +2284,7 @@ export class LedgerClient {
2284
2284
  GetLedgerReportDownloadUrlDocument,
2285
2285
  {
2286
2286
  reportId,
2287
- format: options.format ?? 'JSONLD',
2287
+ format: options.format ?? 'TAVI',
2288
2288
  expiresIn: options.expiresIn ?? 300,
2289
2289
  },
2290
2290
  'Get report download URL',
@@ -9,7 +9,7 @@ export type Incremental<T> = T | {
9
9
  [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never;
10
10
  };
11
11
  import type { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';
12
- export type ReportDownloadFormat = 'HOLON_JSONLD' | 'JSONLD' | 'TAVI' | 'XBRL_2_1';
12
+ export type ReportDownloadFormat = 'HOLON_JSONLD' | 'TAVI' | 'XBRL_2_1';
13
13
  export type GetInvestorHoldingsQueryVariables = Exact<{
14
14
  portfolioId: string;
15
15
  }>;
@@ -3759,7 +3759,7 @@ exports.GetLedgerReportDownloadUrlDocument = {
3759
3759
  kind: 'VariableDefinition',
3760
3760
  variable: { kind: 'Variable', name: { kind: 'Name', value: 'format' } },
3761
3761
  type: { kind: 'NamedType', name: { kind: 'Name', value: 'ReportDownloadFormat' } },
3762
- defaultValue: { kind: 'EnumValue', value: 'JSONLD' },
3762
+ defaultValue: { kind: 'EnumValue', value: 'TAVI' },
3763
3763
  },
3764
3764
  {
3765
3765
  kind: 'VariableDefinition',
@@ -4,7 +4,7 @@ type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] }
4
4
  export type Incremental<T> =
5
5
  T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never }
6
6
  import type { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core'
7
- export type ReportDownloadFormat = 'HOLON_JSONLD' | 'JSONLD' | 'TAVI' | 'XBRL_2_1'
7
+ export type ReportDownloadFormat = 'HOLON_JSONLD' | 'TAVI' | 'XBRL_2_1'
8
8
 
9
9
  export type GetInvestorHoldingsQueryVariables = Exact<{
10
10
  portfolioId: string
@@ -5803,7 +5803,7 @@ export const GetLedgerReportDownloadUrlDocument = {
5803
5803
  kind: 'VariableDefinition',
5804
5804
  variable: { kind: 'Variable', name: { kind: 'Name', value: 'format' } },
5805
5805
  type: { kind: 'NamedType', name: { kind: 'Name', value: 'ReportDownloadFormat' } },
5806
- defaultValue: { kind: 'EnumValue', value: 'JSONLD' },
5806
+ defaultValue: { kind: 'EnumValue', value: 'TAVI' },
5807
5807
  },
5808
5808
  {
5809
5809
  kind: 'VariableDefinition',
@@ -4,9 +4,9 @@
4
4
  * Replaces the retired `GET .../reports/{id}/download` REST resource — a
5
5
  * download is a read of stored state, so it lives on the read surface.
6
6
  * Every flavor resolves to a short-lived presigned S3 URL the client
7
- * follows directly (JSON-LD is stamped at publish time; XBRL, the holon
8
- * and the Tavi compiled model are materialized + cached on first
9
- * request). `format` accepts the `ReportDownloadFormat` enum (`JSONLD`,
10
- * `HOLON_JSONLD`, `XBRL_2_1`, `TAVI`).
7
+ * follows directly (the Tavi compiled model is stamped at publish time;
8
+ * the holon and XBRL are materialized + cached on first request).
9
+ * `format` accepts the `ReportDownloadFormat` enum (`TAVI`,
10
+ * `HOLON_JSONLD`, `XBRL_2_1`).
11
11
  */
12
12
  export declare const GET_REPORT_DOWNLOAD_URL: string;
@@ -8,15 +8,15 @@ const graphql_request_1 = require("graphql-request");
8
8
  * Replaces the retired `GET .../reports/{id}/download` REST resource — a
9
9
  * download is a read of stored state, so it lives on the read surface.
10
10
  * Every flavor resolves to a short-lived presigned S3 URL the client
11
- * follows directly (JSON-LD is stamped at publish time; XBRL, the holon
12
- * and the Tavi compiled model are materialized + cached on first
13
- * request). `format` accepts the `ReportDownloadFormat` enum (`JSONLD`,
14
- * `HOLON_JSONLD`, `XBRL_2_1`, `TAVI`).
11
+ * follows directly (the Tavi compiled model is stamped at publish time;
12
+ * the holon and XBRL are materialized + cached on first request).
13
+ * `format` accepts the `ReportDownloadFormat` enum (`TAVI`,
14
+ * `HOLON_JSONLD`, `XBRL_2_1`).
15
15
  */
16
16
  exports.GET_REPORT_DOWNLOAD_URL = (0, graphql_request_1.gql) `
17
17
  query GetLedgerReportDownloadUrl(
18
18
  $reportId: String!
19
- $format: ReportDownloadFormat = JSONLD
19
+ $format: ReportDownloadFormat = TAVI
20
20
  $expiresIn: Int = 300
21
21
  ) {
22
22
  reportDownloadUrl(reportId: $reportId, format: $format, expiresIn: $expiresIn) {
@@ -6,15 +6,15 @@ import { gql } from 'graphql-request'
6
6
  * Replaces the retired `GET .../reports/{id}/download` REST resource — a
7
7
  * download is a read of stored state, so it lives on the read surface.
8
8
  * Every flavor resolves to a short-lived presigned S3 URL the client
9
- * follows directly (JSON-LD is stamped at publish time; XBRL, the holon
10
- * and the Tavi compiled model are materialized + cached on first
11
- * request). `format` accepts the `ReportDownloadFormat` enum (`JSONLD`,
12
- * `HOLON_JSONLD`, `XBRL_2_1`, `TAVI`).
9
+ * follows directly (the Tavi compiled model is stamped at publish time;
10
+ * the holon and XBRL are materialized + cached on first request).
11
+ * `format` accepts the `ReportDownloadFormat` enum (`TAVI`,
12
+ * `HOLON_JSONLD`, `XBRL_2_1`).
13
13
  */
14
14
  export const GET_REPORT_DOWNLOAD_URL = gql`
15
15
  query GetLedgerReportDownloadUrl(
16
16
  $reportId: String!
17
- $format: ReportDownloadFormat = JSONLD
17
+ $format: ReportDownloadFormat = TAVI
18
18
  $expiresIn: Int = 300
19
19
  ) {
20
20
  reportDownloadUrl(reportId: $reportId, format: $format, expiresIn: $expiresIn) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@robosystems/client",
3
- "version": "2.1.1",
3
+ "version": "2.2.0",
4
4
  "description": "TypeScript client library for the RoboSystems financial intelligence platform",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
package/sdk/sdk.gen.d.ts CHANGED
@@ -378,7 +378,7 @@ export declare const listBackups: <ThrowOnError extends boolean = false>(options
378
378
  /**
379
379
  * Get temporary download URL for backup
380
380
  *
381
- * Generate a temporary download URL for a backup. The filename carries the extension listed as `download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file `{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database file. Decompress the latter with `zstd -d <file>.lbug.zst` (install zstd first: `brew install zstd`, `apt-get install zstd`, or `dnf install zstd`) — no `--long` flag is needed.
381
+ * Generate a temporary download URL for a backup. The filename carries the extension listed as `download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file `{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database file; decompress it with `zstd -d`.
382
382
  */
383
383
  export declare const getBackupDownloadUrl: <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) => RequestResult<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError>;
384
384
  /**
package/sdk/sdk.gen.js CHANGED
@@ -210,11 +210,7 @@ exports.listUserPasskeys = listUserPasskeys;
210
210
  *
211
211
  * Fresh-assertion options for destructive passkey lifecycle actions.
212
212
  */
213
- const getPasskeyReauthOptions = (options) => (options?.client ?? client_gen_1.client).post({
214
- security: [{ name: 'X-API-Key', type: 'apiKey' }],
215
- url: '/v1/auth/passkeys/reauth/options',
216
- ...options
217
- });
213
+ const getPasskeyReauthOptions = (options) => (options?.client ?? client_gen_1.client).post({ url: '/v1/auth/passkeys/reauth/options', ...options });
218
214
  exports.getPasskeyReauthOptions = getPasskeyReauthOptions;
219
215
  /**
220
216
  * Remove Passkey
@@ -222,7 +218,6 @@ exports.getPasskeyReauthOptions = getPasskeyReauthOptions;
222
218
  * Remove one passkey after re-authentication (password or fresh assertion). The last passkey of an MFA-required role cannot be removed while enforcement is active.
223
219
  */
224
220
  const deleteUserPasskey = (options) => (options.client ?? client_gen_1.client).delete({
225
- security: [{ name: 'X-API-Key', type: 'apiKey' }],
226
221
  url: '/v1/auth/passkeys/{passkey_id}',
227
222
  ...options,
228
223
  headers: {
@@ -297,7 +292,6 @@ exports.getMfaStatus = getMfaStatus;
297
292
  * Replace the recovery-code set after re-authentication; codes are shown once.
298
293
  */
299
294
  const regenerateMfaRecoveryCodes = (options) => (options.client ?? client_gen_1.client).post({
300
- security: [{ name: 'X-API-Key', type: 'apiKey' }],
301
295
  url: '/v1/auth/mfa/recovery-codes/regenerate',
302
296
  ...options,
303
297
  headers: {
@@ -756,7 +750,7 @@ exports.listBackups = listBackups;
756
750
  /**
757
751
  * Get temporary download URL for backup
758
752
  *
759
- * Generate a temporary download URL for a backup. The filename carries the extension listed as `download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file `{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database file. Decompress the latter with `zstd -d <file>.lbug.zst` (install zstd first: `brew install zstd`, `apt-get install zstd`, or `dnf install zstd`) — no `--long` flag is needed.
753
+ * Generate a temporary download URL for a backup. The filename carries the extension listed as `download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file `{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database file; decompress it with `zstd -d`.
760
754
  */
761
755
  const getBackupDownloadUrl = (options) => (options.client ?? client_gen_1.client).get({
762
756
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
package/sdk/sdk.gen.ts CHANGED
@@ -222,11 +222,7 @@ export const listUserPasskeys = <ThrowOnError extends boolean = false>(options?:
222
222
  *
223
223
  * Fresh-assertion options for destructive passkey lifecycle actions.
224
224
  */
225
- export const getPasskeyReauthOptions = <ThrowOnError extends boolean = false>(options?: Options<GetPasskeyReauthOptionsData, ThrowOnError>): RequestResult<GetPasskeyReauthOptionsResponses, GetPasskeyReauthOptionsErrors, ThrowOnError> => (options?.client ?? client).post<GetPasskeyReauthOptionsResponses, GetPasskeyReauthOptionsErrors, ThrowOnError>({
226
- security: [{ name: 'X-API-Key', type: 'apiKey' }],
227
- url: '/v1/auth/passkeys/reauth/options',
228
- ...options
229
- });
225
+ export const getPasskeyReauthOptions = <ThrowOnError extends boolean = false>(options?: Options<GetPasskeyReauthOptionsData, ThrowOnError>): RequestResult<GetPasskeyReauthOptionsResponses, GetPasskeyReauthOptionsErrors, ThrowOnError> => (options?.client ?? client).post<GetPasskeyReauthOptionsResponses, GetPasskeyReauthOptionsErrors, ThrowOnError>({ url: '/v1/auth/passkeys/reauth/options', ...options });
230
226
 
231
227
  /**
232
228
  * Remove Passkey
@@ -234,7 +230,6 @@ export const getPasskeyReauthOptions = <ThrowOnError extends boolean = false>(op
234
230
  * Remove one passkey after re-authentication (password or fresh assertion). The last passkey of an MFA-required role cannot be removed while enforcement is active.
235
231
  */
236
232
  export const deleteUserPasskey = <ThrowOnError extends boolean = false>(options: Options<DeleteUserPasskeyData, ThrowOnError>): RequestResult<DeleteUserPasskeyResponses, DeleteUserPasskeyErrors, ThrowOnError> => (options.client ?? client).delete<DeleteUserPasskeyResponses, DeleteUserPasskeyErrors, ThrowOnError>({
237
- security: [{ name: 'X-API-Key', type: 'apiKey' }],
238
233
  url: '/v1/auth/passkeys/{passkey_id}',
239
234
  ...options,
240
235
  headers: {
@@ -309,7 +304,6 @@ export const getMfaStatus = <ThrowOnError extends boolean = false>(options?: Opt
309
304
  * Replace the recovery-code set after re-authentication; codes are shown once.
310
305
  */
311
306
  export const regenerateMfaRecoveryCodes = <ThrowOnError extends boolean = false>(options: Options<RegenerateMfaRecoveryCodesData, ThrowOnError>): RequestResult<RegenerateMfaRecoveryCodesResponses, RegenerateMfaRecoveryCodesErrors, ThrowOnError> => (options.client ?? client).post<RegenerateMfaRecoveryCodesResponses, RegenerateMfaRecoveryCodesErrors, ThrowOnError>({
312
- security: [{ name: 'X-API-Key', type: 'apiKey' }],
313
307
  url: '/v1/auth/mfa/recovery-codes/regenerate',
314
308
  ...options,
315
309
  headers: {
@@ -768,7 +762,7 @@ export const listBackups = <ThrowOnError extends boolean = false>(options: Optio
768
762
  /**
769
763
  * Get temporary download URL for backup
770
764
  *
771
- * Generate a temporary download URL for a backup. The filename carries the extension listed as `download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file `{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database file. Decompress the latter with `zstd -d <file>.lbug.zst` (install zstd first: `brew install zstd`, `apt-get install zstd`, or `dnf install zstd`) — no `--long` flag is needed.
765
+ * Generate a temporary download URL for a backup. The filename carries the extension listed as `download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file `{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database file; decompress it with `zstd -d`.
772
766
  */
773
767
  export const getBackupDownloadUrl = <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>): RequestResult<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError> => (options.client ?? client).get<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError>({
774
768
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],