@robosystems/client 2.1.1 → 2.2.1

package/README.md

@@ -21,16 +21,6 @@ Official TypeScript client for the RoboSystems financial intelligence platform
 npm install @robosystems/client
 ```
 
-## Versioning
-
-This client is `1.x` and follows semantic versioning, with one distinction worth knowing before you pin.
-
-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.
-
-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.
-
-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.
-
 ## Resources
 
 - [RoboSystems Platform](https://robosystems.ai)

package/artifacts/LedgerClient.d.ts

@@ -75,7 +75,7 @@ export interface ReportBundleDownloadResponse {
     expiresAt: string;
     /** MIME type of the artifact behind the URL. */
     contentType: string;
-    /** Serialization flavor — ``jsonld`` or ``xbrl-2.1``. */
+    /** Serialization flavor — ``tavi``, ``holon-jsonld`` or ``xbrl-2.1``. */
     format: string;
     /** Bundle generation number stamped on the Report. */
     generationCount: number;
@@ -761,8 +761,8 @@ export declare class LedgerClient {
      *
      * @param graphId Graph identifier owning the Report.
      * @param reportId Report identifier (rpt_-prefixed ULID).
-     * @param options.format Serialization flavor — `JSONLD` (default), `HOLON_JSONLD`,
-     *   `XBRL_2_1`, or `TAVI` (the Project Tavi compiled model).
+     * @param options.format Serialization flavor — `TAVI` (default, the Project
+     *   Tavi compiled model stamped at publish), `HOLON_JSONLD`, or `XBRL_2_1`.
      * @param options.expiresIn Presigned URL lifetime, in seconds.
      */
     getReportDownloadUrl(graphId: string, reportId: string, options?: {

package/artifacts/LedgerClient.js

@@ -950,14 +950,14 @@ class LedgerClient {
      *
      * @param graphId Graph identifier owning the Report.
      * @param reportId Report identifier (rpt_-prefixed ULID).
-     * @param options.format Serialization flavor — `JSONLD` (default), `HOLON_JSONLD`,
-     *   `XBRL_2_1`, or `TAVI` (the Project Tavi compiled model).
+     * @param options.format Serialization flavor — `TAVI` (default, the Project
+     *   Tavi compiled model stamped at publish), `HOLON_JSONLD`, or `XBRL_2_1`.
      * @param options.expiresIn Presigned URL lifetime, in seconds.
      */
     async getReportDownloadUrl(graphId, reportId, options = {}) {
         return this.gqlQuery(graphId, graphql_1.GetLedgerReportDownloadUrlDocument, {
             reportId,
-            format: options.format ?? 'JSONLD',
+            format: options.format ?? 'TAVI',
             expiresIn: options.expiresIn ?? 300,
         }, 'Get report download URL', (data) => {
             const node = data.reportDownloadUrl;

package/artifacts/LedgerClient.ts

@@ -339,7 +339,7 @@ export interface ReportBundleDownloadResponse {
   expiresAt: string
   /** MIME type of the artifact behind the URL. */
   contentType: string
-  /** Serialization flavor — ``jsonld`` or ``xbrl-2.1``. */
+  /** Serialization flavor — ``tavi``, ``holon-jsonld`` or ``xbrl-2.1``. */
   format: string
   /** Bundle generation number stamped on the Report. */
   generationCount: number
@@ -2270,8 +2270,8 @@ export class LedgerClient {
    *
    * @param graphId Graph identifier owning the Report.
    * @param reportId Report identifier (rpt_-prefixed ULID).
-   * @param options.format Serialization flavor — `JSONLD` (default), `HOLON_JSONLD`,
-   *   `XBRL_2_1`, or `TAVI` (the Project Tavi compiled model).
+   * @param options.format Serialization flavor — `TAVI` (default, the Project
+   *   Tavi compiled model stamped at publish), `HOLON_JSONLD`, or `XBRL_2_1`.
    * @param options.expiresIn Presigned URL lifetime, in seconds.
    */
   async getReportDownloadUrl(
@@ -2284,7 +2284,7 @@ export class LedgerClient {
       GetLedgerReportDownloadUrlDocument,
       {
         reportId,
-        format: options.format ?? 'JSONLD',
+        format: options.format ?? 'TAVI',
         expiresIn: options.expiresIn ?? 300,
       },
       'Get report download URL',

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

@@ -9,7 +9,7 @@ export type Incremental<T> = T | {
     [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never;
 };
 import type { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';
-export type ReportDownloadFormat = 'HOLON_JSONLD' | 'JSONLD' | 'TAVI' | 'XBRL_2_1';
+export type ReportDownloadFormat = 'HOLON_JSONLD' | 'TAVI' | 'XBRL_2_1';
 export type GetInvestorHoldingsQueryVariables = Exact<{
     portfolioId: string;
 }>;

package/artifacts/graphql/generated/graphql.js

@@ -3759,7 +3759,7 @@ exports.GetLedgerReportDownloadUrlDocument = {
                     kind: 'VariableDefinition',
                     variable: { kind: 'Variable', name: { kind: 'Name', value: 'format' } },
                     type: { kind: 'NamedType', name: { kind: 'Name', value: 'ReportDownloadFormat' } },
-                    defaultValue: { kind: 'EnumValue', value: 'JSONLD' },
+                    defaultValue: { kind: 'EnumValue', value: 'TAVI' },
                 },
                 {
                     kind: 'VariableDefinition',

package/artifacts/graphql/generated/graphql.ts

@@ -4,7 +4,7 @@ type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] }
 export type Incremental<T> =
   T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never }
 import type { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core'
-export type ReportDownloadFormat = 'HOLON_JSONLD' | 'JSONLD' | 'TAVI' | 'XBRL_2_1'
+export type ReportDownloadFormat = 'HOLON_JSONLD' | 'TAVI' | 'XBRL_2_1'
 
 export type GetInvestorHoldingsQueryVariables = Exact<{
   portfolioId: string
@@ -5803,7 +5803,7 @@ export const GetLedgerReportDownloadUrlDocument = {
           kind: 'VariableDefinition',
           variable: { kind: 'Variable', name: { kind: 'Name', value: 'format' } },
           type: { kind: 'NamedType', name: { kind: 'Name', value: 'ReportDownloadFormat' } },
-          defaultValue: { kind: 'EnumValue', value: 'JSONLD' },
+          defaultValue: { kind: 'EnumValue', value: 'TAVI' },
         },
         {
           kind: 'VariableDefinition',

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

@@ -4,9 +4,9 @@
  * Replaces the retired `GET .../reports/{id}/download` REST resource — a
  * download is a read of stored state, so it lives on the read surface.
  * Every flavor resolves to a short-lived presigned S3 URL the client
- * follows directly (JSON-LD is stamped at publish time; XBRL, the holon
- * and the Tavi compiled model are materialized + cached on first
- * request). `format` accepts the `ReportDownloadFormat` enum (`JSONLD`,
- * `HOLON_JSONLD`, `XBRL_2_1`, `TAVI`).
+ * follows directly (the Tavi compiled model is stamped at publish time;
+ * the holon and XBRL are materialized + cached on first request).
+ * `format` accepts the `ReportDownloadFormat` enum (`TAVI`,
+ * `HOLON_JSONLD`, `XBRL_2_1`).
  */
 export declare const GET_REPORT_DOWNLOAD_URL: string;

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

@@ -8,15 +8,15 @@ const graphql_request_1 = require("graphql-request");
  * Replaces the retired `GET .../reports/{id}/download` REST resource — a
  * download is a read of stored state, so it lives on the read surface.
  * Every flavor resolves to a short-lived presigned S3 URL the client
- * follows directly (JSON-LD is stamped at publish time; XBRL, the holon
- * and the Tavi compiled model are materialized + cached on first
- * request). `format` accepts the `ReportDownloadFormat` enum (`JSONLD`,
- * `HOLON_JSONLD`, `XBRL_2_1`, `TAVI`).
+ * follows directly (the Tavi compiled model is stamped at publish time;
+ * the holon and XBRL are materialized + cached on first request).
+ * `format` accepts the `ReportDownloadFormat` enum (`TAVI`,
+ * `HOLON_JSONLD`, `XBRL_2_1`).
  */
 exports.GET_REPORT_DOWNLOAD_URL = (0, graphql_request_1.gql) `
   query GetLedgerReportDownloadUrl(
     $reportId: String!
-    $format: ReportDownloadFormat = JSONLD
+    $format: ReportDownloadFormat = TAVI
     $expiresIn: Int = 300
   ) {
     reportDownloadUrl(reportId: $reportId, format: $format, expiresIn: $expiresIn) {

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

@@ -6,15 +6,15 @@ import { gql } from 'graphql-request'
  * Replaces the retired `GET .../reports/{id}/download` REST resource — a
  * download is a read of stored state, so it lives on the read surface.
  * Every flavor resolves to a short-lived presigned S3 URL the client
- * follows directly (JSON-LD is stamped at publish time; XBRL, the holon
- * and the Tavi compiled model are materialized + cached on first
- * request). `format` accepts the `ReportDownloadFormat` enum (`JSONLD`,
- * `HOLON_JSONLD`, `XBRL_2_1`, `TAVI`).
+ * follows directly (the Tavi compiled model is stamped at publish time;
+ * the holon and XBRL are materialized + cached on first request).
+ * `format` accepts the `ReportDownloadFormat` enum (`TAVI`,
+ * `HOLON_JSONLD`, `XBRL_2_1`).
  */
 export const GET_REPORT_DOWNLOAD_URL = gql`
   query GetLedgerReportDownloadUrl(
     $reportId: String!
-    $format: ReportDownloadFormat = JSONLD
+    $format: ReportDownloadFormat = TAVI
     $expiresIn: Int = 300
   ) {
     reportDownloadUrl(reportId: $reportId, format: $format, expiresIn: $expiresIn) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@robosystems/client",
-  "version": "2.1.1",
+  "version": "2.2.1",
   "description": "TypeScript client library for the RoboSystems financial intelligence platform",
   "main": "index.js",
   "types": "index.d.ts",

package/sdk/sdk.gen.d.ts

@@ -378,7 +378,7 @@ export declare const listBackups: <ThrowOnError extends boolean = false>(options
 /**
  * Get temporary download URL for backup
  *
- * 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.
+ * 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`.
  */
 export declare const getBackupDownloadUrl: <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>) => RequestResult<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError>;
 /**

package/sdk/sdk.gen.js

@@ -210,11 +210,7 @@ exports.listUserPasskeys = listUserPasskeys;
  *
  * Fresh-assertion options for destructive passkey lifecycle actions.
  */
-const getPasskeyReauthOptions = (options) => (options?.client ?? client_gen_1.client).post({
-    security: [{ name: 'X-API-Key', type: 'apiKey' }],
-    url: '/v1/auth/passkeys/reauth/options',
-    ...options
-});
+const getPasskeyReauthOptions = (options) => (options?.client ?? client_gen_1.client).post({ url: '/v1/auth/passkeys/reauth/options', ...options });
 exports.getPasskeyReauthOptions = getPasskeyReauthOptions;
 /**
  * Remove Passkey
@@ -222,7 +218,6 @@ exports.getPasskeyReauthOptions = getPasskeyReauthOptions;
  * 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.
  */
 const deleteUserPasskey = (options) => (options.client ?? client_gen_1.client).delete({
-    security: [{ name: 'X-API-Key', type: 'apiKey' }],
     url: '/v1/auth/passkeys/{passkey_id}',
     ...options,
     headers: {
@@ -297,7 +292,6 @@ exports.getMfaStatus = getMfaStatus;
  * Replace the recovery-code set after re-authentication; codes are shown once.
  */
 const regenerateMfaRecoveryCodes = (options) => (options.client ?? client_gen_1.client).post({
-    security: [{ name: 'X-API-Key', type: 'apiKey' }],
     url: '/v1/auth/mfa/recovery-codes/regenerate',
     ...options,
     headers: {
@@ -756,7 +750,7 @@ exports.listBackups = listBackups;
 /**
  * Get temporary download URL for backup
  *
- * 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.
+ * 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`.
  */
 const getBackupDownloadUrl = (options) => (options.client ?? client_gen_1.client).get({
     security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],

package/sdk/sdk.gen.ts

@@ -222,11 +222,7 @@ export const listUserPasskeys = <ThrowOnError extends boolean = false>(options?:
  *
  * Fresh-assertion options for destructive passkey lifecycle actions.
  */
-export const getPasskeyReauthOptions = <ThrowOnError extends boolean = false>(options?: Options<GetPasskeyReauthOptionsData, ThrowOnError>): RequestResult<GetPasskeyReauthOptionsResponses, GetPasskeyReauthOptionsErrors, ThrowOnError> => (options?.client ?? client).post<GetPasskeyReauthOptionsResponses, GetPasskeyReauthOptionsErrors, ThrowOnError>({
-    security: [{ name: 'X-API-Key', type: 'apiKey' }],
-    url: '/v1/auth/passkeys/reauth/options',
-    ...options
-});
+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 });
 
 /**
  * Remove Passkey
@@ -234,7 +230,6 @@ export const getPasskeyReauthOptions = <ThrowOnError extends boolean = false>(op
  * 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.
  */
 export const deleteUserPasskey = <ThrowOnError extends boolean = false>(options: Options<DeleteUserPasskeyData, ThrowOnError>): RequestResult<DeleteUserPasskeyResponses, DeleteUserPasskeyErrors, ThrowOnError> => (options.client ?? client).delete<DeleteUserPasskeyResponses, DeleteUserPasskeyErrors, ThrowOnError>({
-    security: [{ name: 'X-API-Key', type: 'apiKey' }],
     url: '/v1/auth/passkeys/{passkey_id}',
     ...options,
     headers: {
@@ -309,7 +304,6 @@ export const getMfaStatus = <ThrowOnError extends boolean = false>(options?: Opt
  * Replace the recovery-code set after re-authentication; codes are shown once.
  */
 export const regenerateMfaRecoveryCodes = <ThrowOnError extends boolean = false>(options: Options<RegenerateMfaRecoveryCodesData, ThrowOnError>): RequestResult<RegenerateMfaRecoveryCodesResponses, RegenerateMfaRecoveryCodesErrors, ThrowOnError> => (options.client ?? client).post<RegenerateMfaRecoveryCodesResponses, RegenerateMfaRecoveryCodesErrors, ThrowOnError>({
-    security: [{ name: 'X-API-Key', type: 'apiKey' }],
     url: '/v1/auth/mfa/recovery-codes/regenerate',
     ...options,
     headers: {
@@ -768,7 +762,7 @@ export const listBackups = <ThrowOnError extends boolean = false>(options: Optio
 /**
  * Get temporary download URL for backup
  *
- * 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.
+ * 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`.
  */
 export const getBackupDownloadUrl = <ThrowOnError extends boolean = false>(options: Options<GetBackupDownloadUrlData, ThrowOnError>): RequestResult<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError> => (options.client ?? client).get<GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, ThrowOnError>({
     security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],