@arbidocs/client 0.3.135 → 0.3.136

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/dist/index.d.cts CHANGED
@@ -2726,6 +2726,33 @@ interface paths {
2726
2726
  patch?: never;
2727
2727
  trace?: never;
2728
2728
  };
2729
+ '/v1/connectors/{vendor_key}/admin-consent': {
2730
+ parameters: {
2731
+ query?: never;
2732
+ header?: never;
2733
+ path?: never;
2734
+ cookie?: never;
2735
+ };
2736
+ /**
2737
+ * Start the Microsoft org admin-consent flow (public, no login)
2738
+ * @description Redirect an IT admin to Microsoft's org-wide admin-consent screen.
2739
+ *
2740
+ * Public by design: the whole point is that the customer's Microsoft admin can
2741
+ * authorize ARBI for their organization WITHOUT having an ARBI account — a user
2742
+ * shares ``/{ADMIN_CONSENT_PAGE}`` (which links here), the admin approves on
2743
+ * login.microsoftonline.com, and Microsoft redirects back to the regular OAuth
2744
+ * callback (already registered on the Entra app) with ``state=admin-consent``.
2745
+ * No secrets are exposed: the URL carries only the public client id + scopes.
2746
+ */
2747
+ get: operations['start_admin_consent'];
2748
+ put?: never;
2749
+ post?: never;
2750
+ delete?: never;
2751
+ options?: never;
2752
+ head?: never;
2753
+ patch?: never;
2754
+ trace?: never;
2755
+ };
2729
2756
  '/v1/connectors/{vendor_key}/callback': {
2730
2757
  parameters: {
2731
2758
  query?: never;
@@ -2736,6 +2763,13 @@ interface paths {
2736
2763
  /**
2737
2764
  * OAuth callback — exchange code for tokens
2738
2765
  * @description Handle the OAuth callback: exchange code, encrypt + store tokens, redirect.
2766
+ *
2767
+ * The provider may redirect back with an error instead of a code — e.g. the user
2768
+ * declines consent, or a SharePoint admin-consent wall blocks the grant
2769
+ * (``?error=access_denied&state=...`` with no ``code``). Rather than let FastAPI
2770
+ * reject the missing ``code`` with a raw 422, treat that (and any explicit
2771
+ * ``error``) as a graceful failure: best-effort consume the one-time PKCE state and
2772
+ * redirect the user back to the app with ``?connect_error={vendor_key}``.
2739
2773
  */
2740
2774
  get: operations['oauth_callback'];
2741
2775
  put?: never;
@@ -3426,7 +3460,7 @@ interface components {
3426
3460
  /**
3427
3461
  * Subagents Enabled
3428
3462
  * @description Include the sub_agent tool so the agent can spawn detached background sub-agents and control them (check / steer / pause / resume / collect) while it keeps working — parallel delegation, unlike the blocking deep_research. Fan-out is one level deep and capped in concurrency.
3429
- * @default false
3463
+ * @default true
3430
3464
  */
3431
3465
  SUBAGENTS_ENABLED: boolean;
3432
3466
  /**
@@ -3669,7 +3703,7 @@ interface components {
3669
3703
  /**
3670
3704
  * Subagents Enabled
3671
3705
  * @description Include the sub_agent tool so the agent can spawn detached background sub-agents and control them (check / steer / pause / resume / collect) while it keeps working — parallel delegation, unlike the blocking deep_research. Fan-out is one level deep and capped in concurrency.
3672
- * @default false
3706
+ * @default true
3673
3707
  */
3674
3708
  SUBAGENTS_ENABLED: boolean;
3675
3709
  /**
@@ -3779,7 +3813,7 @@ interface components {
3779
3813
  * "MCP_TOOLS": [],
3780
3814
  * "PLANNING_ENABLED": false,
3781
3815
  * "DEEP_RESEARCH_ENABLED": true,
3782
- * "SUBAGENTS_ENABLED": false,
3816
+ * "SUBAGENTS_ENABLED": true,
3783
3817
  * "SUGGESTED_QUERIES": false,
3784
3818
  * "ARTIFACTS_ENABLED": false,
3785
3819
  * "IMAGE_ENABLED": false,
@@ -4024,7 +4058,7 @@ interface components {
4024
4058
  * "IMAGE": "arbi-sandbox:bookworm-slim",
4025
4059
  * "TIMEOUT_SECONDS": 60,
4026
4060
  * "MEMORY_LIMIT": "512m",
4027
- * "NETWORK": "bridge"
4061
+ * "NETWORK": "arbi-sandbox-net"
4028
4062
  * }
4029
4063
  */
4030
4064
  RunCode: components['schemas']['RunCodeConfig'];
@@ -4067,7 +4101,7 @@ interface components {
4067
4101
  * },
4068
4102
  * "MAX_CONCURRENT_REQUESTS": 256,
4069
4103
  * "MODEL_NAME": "Qwen/Qwen3-Reranker-0.6B",
4070
- * "API_TYPE": "remote",
4104
+ * "API_TYPE": "local",
4071
4105
  * "RETRIEVAL_INSTRUCTION": "Judge whether the passage contains the specific facts, figures, names, or references mentioned in the query. Only answer yes if the passage directly contains these details"
4072
4106
  * }
4073
4107
  */
@@ -4088,7 +4122,7 @@ interface components {
4088
4122
  /**
4089
4123
  * @default {
4090
4124
  * "MODEL_NAME": "Qwen/Qwen3-Embedding-0.6B",
4091
- * "API_TYPE": "remote",
4125
+ * "API_TYPE": "local",
4092
4126
  * "BATCH_SIZE": 128,
4093
4127
  * "MAX_CONCURRENT_REQUESTS": 256,
4094
4128
  * "DOCUMENT_PREFIX": "",
@@ -6048,7 +6082,7 @@ interface components {
6048
6082
  /**
6049
6083
  * Api Type
6050
6084
  * @description The inference type (local or remote).
6051
- * @default remote
6085
+ * @default local
6052
6086
  * @enum {string}
6053
6087
  */
6054
6088
  API_TYPE: 'local' | 'remote';
@@ -6369,7 +6403,12 @@ interface components {
6369
6403
  };
6370
6404
  /**
6371
6405
  * FolderRead
6372
- * @description A selectable mail folder (Outlook) or label (Gmail).
6406
+ * @description A mail folder (Outlook), label (Gmail), or drive folder/site/library.
6407
+ *
6408
+ * Mail folders and ordinary drive folders are always selectable. Drive listings may
6409
+ * also surface non-selectable grouping nodes (e.g. a SharePoint *site*, which
6410
+ * contains document libraries but no files of its own) — ``selectable=False`` tells
6411
+ * the picker to render them as expandable-only branches.
6373
6412
  */
6374
6413
  FolderRead: {
6375
6414
  /** Id */
@@ -6378,6 +6417,11 @@ interface components {
6378
6417
  name: string;
6379
6418
  /** Count */
6380
6419
  count?: number | null;
6420
+ /**
6421
+ * Selectable
6422
+ * @default true
6423
+ */
6424
+ selectable: boolean;
6381
6425
  };
6382
6426
  /**
6383
6427
  * FunctionCallItem
@@ -8379,7 +8423,7 @@ interface components {
8379
8423
  /**
8380
8424
  * Api Type
8381
8425
  * @description The inference type (local or remote).
8382
- * @default remote
8426
+ * @default local
8383
8427
  * @enum {string}
8384
8428
  */
8385
8429
  API_TYPE: 'local' | 'remote';
@@ -9226,8 +9270,8 @@ interface components {
9226
9270
  MEMORY_LIMIT: string;
9227
9271
  /**
9228
9272
  * Network
9229
- * @description Container network mode. 'bridge' allows internet (pip/npm install). 'none' for full isolation.
9230
- * @default bridge
9273
+ * @description Container network mode. 'arbi-sandbox-net' is the dedicated internal network created at deploy time: no egress at all (no internet, no LAN, no host), and other sandboxes are unreachable. Web access belongs to web_search / deep_research, not to executed code. Do not use 'bridge' — it would give model-authored code the host's whole network.
9274
+ * @default arbi-sandbox-net
9231
9275
  */
9232
9276
  NETWORK: string;
9233
9277
  };
@@ -10844,6 +10888,11 @@ interface components {
10844
10888
  * @default true
10845
10889
  */
10846
10890
  show_connector_microsoft: boolean;
10891
+ /**
10892
+ * Show Connector Sharepoint
10893
+ * @default false
10894
+ */
10895
+ show_connector_sharepoint: boolean;
10847
10896
  /**
10848
10897
  * Show Connector Google
10849
10898
  * @default false
@@ -10949,6 +10998,8 @@ interface components {
10949
10998
  show_mcp_connectors?: boolean | null;
10950
10999
  /** Show Connector Microsoft */
10951
11000
  show_connector_microsoft?: boolean | null;
11001
+ /** Show Connector Sharepoint */
11002
+ show_connector_sharepoint?: boolean | null;
10952
11003
  /** Show Connector Google */
10953
11004
  show_connector_google?: boolean | null;
10954
11005
  /** Show Connector Imanage */
@@ -10999,7 +11050,7 @@ interface components {
10999
11050
  * (FastAPI validates + documents the allowed set) and the catalog keys.
11000
11051
  * @enum {string}
11001
11052
  */
11002
- VendorKey: 'microsoft' | 'gdrive' | 'gmail' | 'imanage' | 'westlaw' | 'ms365_mail';
11053
+ VendorKey: 'microsoft' | 'microsoft_sharepoint' | 'gdrive' | 'gmail' | 'imanage' | 'westlaw' | 'ms365_mail';
11003
11054
  /** VerifyEmailRequest */
11004
11055
  VerifyEmailRequest: {
11005
11056
  /**
@@ -15444,11 +15495,46 @@ interface operations {
15444
15495
  };
15445
15496
  };
15446
15497
  };
15498
+ start_admin_consent: {
15499
+ parameters: {
15500
+ query?: never;
15501
+ header?: never;
15502
+ path: {
15503
+ vendor_key: components['schemas']['VendorKey'];
15504
+ };
15505
+ cookie?: never;
15506
+ };
15507
+ requestBody?: never;
15508
+ responses: {
15509
+ /** @description Successful Response */
15510
+ 200: {
15511
+ headers: {
15512
+ [name: string]: unknown;
15513
+ };
15514
+ content: {
15515
+ 'application/json': unknown;
15516
+ };
15517
+ };
15518
+ /** @description Validation Error */
15519
+ 422: {
15520
+ headers: {
15521
+ [name: string]: unknown;
15522
+ };
15523
+ content: {
15524
+ 'application/json': components['schemas']['HTTPValidationError'];
15525
+ };
15526
+ };
15527
+ };
15528
+ };
15447
15529
  oauth_callback: {
15448
15530
  parameters: {
15449
- query: {
15450
- code: string;
15451
- state: string;
15531
+ query?: {
15532
+ code?: string | null;
15533
+ state?: string | null;
15534
+ error?: string | null;
15535
+ error_description?: string | null;
15536
+ admin_consent?: string | null;
15537
+ tenant?: string | null;
15452
15538
  };
15453
15539
  header?: never;
15454
15540
  path: {
package/dist/index.d.ts CHANGED
@@ -2726,6 +2726,33 @@ interface paths {
2726
2726
  patch?: never;
2727
2727
  trace?: never;
2728
2728
  };
2729
+ '/v1/connectors/{vendor_key}/admin-consent': {
2730
+ parameters: {
2731
+ query?: never;
2732
+ header?: never;
2733
+ path?: never;
2734
+ cookie?: never;
2735
+ };
2736
+ /**
2737
+ * Start the Microsoft org admin-consent flow (public, no login)
2738
+ * @description Redirect an IT admin to Microsoft's org-wide admin-consent screen.
2739
+ *
2740
+ * Public by design: the whole point is that the customer's Microsoft admin can
2741
+ * authorize ARBI for their organization WITHOUT having an ARBI account — a user
2742
+ * shares ``/{ADMIN_CONSENT_PAGE}`` (which links here), the admin approves on
2743
+ * login.microsoftonline.com, and Microsoft redirects back to the regular OAuth
2744
+ * callback (already registered on the Entra app) with ``state=admin-consent``.
2745
+ * No secrets are exposed: the URL carries only the public client id + scopes.
2746
+ */
2747
+ get: operations['start_admin_consent'];
2748
+ put?: never;
2749
+ post?: never;
2750
+ delete?: never;
2751
+ options?: never;
2752
+ head?: never;
2753
+ patch?: never;
2754
+ trace?: never;
2755
+ };
2729
2756
  '/v1/connectors/{vendor_key}/callback': {
2730
2757
  parameters: {
2731
2758
  query?: never;
@@ -2736,6 +2763,13 @@ interface paths {
2736
2763
  /**
2737
2764
  * OAuth callback — exchange code for tokens
2738
2765
  * @description Handle the OAuth callback: exchange code, encrypt + store tokens, redirect.
2766
+ *
2767
+ * The provider may redirect back with an error instead of a code — e.g. the user
2768
+ * declines consent, or a SharePoint admin-consent wall blocks the grant
2769
+ * (``?error=access_denied&state=...`` with no ``code``). Rather than let FastAPI
2770
+ * reject the missing ``code`` with a raw 422, treat that (and any explicit
2771
+ * ``error``) as a graceful failure: best-effort consume the one-time PKCE state and
2772
+ * redirect the user back to the app with ``?connect_error={vendor_key}``.
2739
2773
  */
2740
2774
  get: operations['oauth_callback'];
2741
2775
  put?: never;
@@ -3426,7 +3460,7 @@ interface components {
3426
3460
  /**
3427
3461
  * Subagents Enabled
3428
3462
  * @description Include the sub_agent tool so the agent can spawn detached background sub-agents and control them (check / steer / pause / resume / collect) while it keeps working — parallel delegation, unlike the blocking deep_research. Fan-out is one level deep and capped in concurrency.
3429
- * @default false
3463
+ * @default true
3430
3464
  */
3431
3465
  SUBAGENTS_ENABLED: boolean;
3432
3466
  /**
@@ -3669,7 +3703,7 @@ interface components {
3669
3703
  /**
3670
3704
  * Subagents Enabled
3671
3705
  * @description Include the sub_agent tool so the agent can spawn detached background sub-agents and control them (check / steer / pause / resume / collect) while it keeps working — parallel delegation, unlike the blocking deep_research. Fan-out is one level deep and capped in concurrency.
3672
- * @default false
3706
+ * @default true
3673
3707
  */
3674
3708
  SUBAGENTS_ENABLED: boolean;
3675
3709
  /**
@@ -3779,7 +3813,7 @@ interface components {
3779
3813
  * "MCP_TOOLS": [],
3780
3814
  * "PLANNING_ENABLED": false,
3781
3815
  * "DEEP_RESEARCH_ENABLED": true,
3782
- * "SUBAGENTS_ENABLED": false,
3816
+ * "SUBAGENTS_ENABLED": true,
3783
3817
  * "SUGGESTED_QUERIES": false,
3784
3818
  * "ARTIFACTS_ENABLED": false,
3785
3819
  * "IMAGE_ENABLED": false,
@@ -4024,7 +4058,7 @@ interface components {
4024
4058
  * "IMAGE": "arbi-sandbox:bookworm-slim",
4025
4059
  * "TIMEOUT_SECONDS": 60,
4026
4060
  * "MEMORY_LIMIT": "512m",
4027
- * "NETWORK": "bridge"
4061
+ * "NETWORK": "arbi-sandbox-net"
4028
4062
  * }
4029
4063
  */
4030
4064
  RunCode: components['schemas']['RunCodeConfig'];
@@ -4067,7 +4101,7 @@ interface components {
4067
4101
  * },
4068
4102
  * "MAX_CONCURRENT_REQUESTS": 256,
4069
4103
  * "MODEL_NAME": "Qwen/Qwen3-Reranker-0.6B",
4070
- * "API_TYPE": "remote",
4104
+ * "API_TYPE": "local",
4071
4105
  * "RETRIEVAL_INSTRUCTION": "Judge whether the passage contains the specific facts, figures, names, or references mentioned in the query. Only answer yes if the passage directly contains these details"
4072
4106
  * }
4073
4107
  */
@@ -4088,7 +4122,7 @@ interface components {
4088
4122
  /**
4089
4123
  * @default {
4090
4124
  * "MODEL_NAME": "Qwen/Qwen3-Embedding-0.6B",
4091
- * "API_TYPE": "remote",
4125
+ * "API_TYPE": "local",
4092
4126
  * "BATCH_SIZE": 128,
4093
4127
  * "MAX_CONCURRENT_REQUESTS": 256,
4094
4128
  * "DOCUMENT_PREFIX": "",
@@ -6048,7 +6082,7 @@ interface components {
6048
6082
  /**
6049
6083
  * Api Type
6050
6084
  * @description The inference type (local or remote).
6051
- * @default remote
6085
+ * @default local
6052
6086
  * @enum {string}
6053
6087
  */
6054
6088
  API_TYPE: 'local' | 'remote';
@@ -6369,7 +6403,12 @@ interface components {
6369
6403
  };
6370
6404
  /**
6371
6405
  * FolderRead
6372
- * @description A selectable mail folder (Outlook) or label (Gmail).
6406
+ * @description A mail folder (Outlook), label (Gmail), or drive folder/site/library.
6407
+ *
6408
+ * Mail folders and ordinary drive folders are always selectable. Drive listings may
6409
+ * also surface non-selectable grouping nodes (e.g. a SharePoint *site*, which
6410
+ * contains document libraries but no files of its own) — ``selectable=False`` tells
6411
+ * the picker to render them as expandable-only branches.
6373
6412
  */
6374
6413
  FolderRead: {
6375
6414
  /** Id */
@@ -6378,6 +6417,11 @@ interface components {
6378
6417
  name: string;
6379
6418
  /** Count */
6380
6419
  count?: number | null;
6420
+ /**
6421
+ * Selectable
6422
+ * @default true
6423
+ */
6424
+ selectable: boolean;
6381
6425
  };
6382
6426
  /**
6383
6427
  * FunctionCallItem
@@ -8379,7 +8423,7 @@ interface components {
8379
8423
  /**
8380
8424
  * Api Type
8381
8425
  * @description The inference type (local or remote).
8382
- * @default remote
8426
+ * @default local
8383
8427
  * @enum {string}
8384
8428
  */
8385
8429
  API_TYPE: 'local' | 'remote';
@@ -9226,8 +9270,8 @@ interface components {
9226
9270
  MEMORY_LIMIT: string;
9227
9271
  /**
9228
9272
  * Network
9229
- * @description Container network mode. 'bridge' allows internet (pip/npm install). 'none' for full isolation.
9230
- * @default bridge
9273
+ * @description Container network mode. 'arbi-sandbox-net' is the dedicated internal network created at deploy time: no egress at all (no internet, no LAN, no host), and other sandboxes are unreachable. Web access belongs to web_search / deep_research, not to executed code. Do not use 'bridge' — it would give model-authored code the host's whole network.
9274
+ * @default arbi-sandbox-net
9231
9275
  */
9232
9276
  NETWORK: string;
9233
9277
  };
@@ -10844,6 +10888,11 @@ interface components {
10844
10888
  * @default true
10845
10889
  */
10846
10890
  show_connector_microsoft: boolean;
10891
+ /**
10892
+ * Show Connector Sharepoint
10893
+ * @default false
10894
+ */
10895
+ show_connector_sharepoint: boolean;
10847
10896
  /**
10848
10897
  * Show Connector Google
10849
10898
  * @default false
@@ -10949,6 +10998,8 @@ interface components {
10949
10998
  show_mcp_connectors?: boolean | null;
10950
10999
  /** Show Connector Microsoft */
10951
11000
  show_connector_microsoft?: boolean | null;
11001
+ /** Show Connector Sharepoint */
11002
+ show_connector_sharepoint?: boolean | null;
10952
11003
  /** Show Connector Google */
10953
11004
  show_connector_google?: boolean | null;
10954
11005
  /** Show Connector Imanage */
@@ -10999,7 +11050,7 @@ interface components {
10999
11050
  * (FastAPI validates + documents the allowed set) and the catalog keys.
11000
11051
  * @enum {string}
11001
11052
  */
11002
- VendorKey: 'microsoft' | 'gdrive' | 'gmail' | 'imanage' | 'westlaw' | 'ms365_mail';
11053
+ VendorKey: 'microsoft' | 'microsoft_sharepoint' | 'gdrive' | 'gmail' | 'imanage' | 'westlaw' | 'ms365_mail';
11003
11054
  /** VerifyEmailRequest */
11004
11055
  VerifyEmailRequest: {
11005
11056
  /**
@@ -15444,11 +15495,46 @@ interface operations {
15444
15495
  };
15445
15496
  };
15446
15497
  };
15498
+ start_admin_consent: {
15499
+ parameters: {
15500
+ query?: never;
15501
+ header?: never;
15502
+ path: {
15503
+ vendor_key: components['schemas']['VendorKey'];
15504
+ };
15505
+ cookie?: never;
15506
+ };
15507
+ requestBody?: never;
15508
+ responses: {
15509
+ /** @description Successful Response */
15510
+ 200: {
15511
+ headers: {
15512
+ [name: string]: unknown;
15513
+ };
15514
+ content: {
15515
+ 'application/json': unknown;
15516
+ };
15517
+ };
15518
+ /** @description Validation Error */
15519
+ 422: {
15520
+ headers: {
15521
+ [name: string]: unknown;
15522
+ };
15523
+ content: {
15524
+ 'application/json': components['schemas']['HTTPValidationError'];
15525
+ };
15526
+ };
15527
+ };
15528
+ };
15447
15529
  oauth_callback: {
15448
15530
  parameters: {
15449
- query: {
15450
- code: string;
15451
- state: string;
15531
+ query?: {
15532
+ code?: string | null;
15533
+ state?: string | null;
15534
+ error?: string | null;
15535
+ error_description?: string | null;
15536
+ admin_consent?: string | null;
15537
+ tenant?: string | null;
15452
15538
  };
15453
15539
  header?: never;
15454
15540
  path: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@arbidocs/client",
3
- "version": "0.3.135",
3
+ "version": "0.3.136",
4
4
  "description": "TypeScript SDK for the ARBI API — zero-knowledge auth, E2E encryption, and type-safe REST client",
5
5
  "type": "module",
6
6
  "main": "dist/index.cjs",