@arbidocs/client 0.3.182 → 0.3.183

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
@@ -1988,6 +1988,30 @@ interface paths {
1988
1988
  patch?: never;
1989
1989
  trace?: never;
1990
1990
  };
1991
+ '/v1/facts/batch': {
1992
+ parameters: {
1993
+ query?: never;
1994
+ header?: never;
1995
+ path?: never;
1996
+ cookie?: never;
1997
+ };
1998
+ get?: never;
1999
+ put?: never;
2000
+ /**
2001
+ * Create Facts Batch Endpoint
2002
+ * @description Create several facts in one transaction — all of them, or none.
2003
+ *
2004
+ * Prefer this to a loop of single creates for an import: tags are resolved once and the facts are
2005
+ * embedded in batches after the commit, rather than one request, one tag lookup and one background
2006
+ * embedding task per fact. Responses come back in request order.
2007
+ */
2008
+ post: operations['create_facts_batch'];
2009
+ delete?: never;
2010
+ options?: never;
2011
+ head?: never;
2012
+ patch?: never;
2013
+ trace?: never;
2014
+ };
1991
2015
  '/v1/facts/list': {
1992
2016
  parameters: {
1993
2017
  query?: never;
@@ -2003,6 +2027,9 @@ interface paths {
2003
2027
  * into the timeline: only dated facts, ordered by when they happened. Each
2004
2028
  * bound is read at its own precision and widened outward, so ``date_to=2019``
2005
2029
  * runs through 31 December rather than stopping on 1 January.
2030
+ *
2031
+ * Narrow with ``tag_ext_id`` (repeatable; a fact must carry all of them) and ``doc_ext_id``, and page
2032
+ * with ``limit``/``offset`` — a large workspace need not be fetched whole.
2006
2033
  */
2007
2034
  get: operations['list_facts'];
2008
2035
  put?: never;
@@ -3401,6 +3428,20 @@ interface components {
3401
3428
  * follow-up call with this set to true for those specific emails actually sends the
3402
3429
  * invite and deposits the pending workspace-share grant. Without this gate, sharing
3403
3430
  * would email and grant future access to a typo'd address with no chance to back out.
3431
+ *
3432
+ * resource_type + resource_ext_id (optional): set when this call came from sharing a
3433
+ * specific document or conversation by email rather than the workspace itself (the
3434
+ * "Share" action on a resource). Every recipient still goes through the normal
3435
+ * add-user flow above (same role, same confirm_invite gate) — this only attaches a
3436
+ * breadcrumb so the invite/notification carries a deep link to the resource instead
3437
+ * of just the workspace, and Contacts.shared_resource_* survives an unregistered
3438
+ * recipient's registration so their first login redirects straight there.
3439
+ *
3440
+ * confirm_share (default False): required when the named resource is currently
3441
+ * private — sharing it externally makes it visible to every workspace member, not
3442
+ * just the recipients, so this mirrors confirm_invite's explicit-opt-in gate. A call
3443
+ * naming a private resource without this set does nothing and reports that a
3444
+ * confirmation is needed; the caller re-calls with it set once the owner confirms.
3404
3445
  */
3405
3446
  AddWorkspaceUsersRequest: {
3406
3447
  /** Emails */
@@ -3415,6 +3456,12 @@ interface components {
3415
3456
  session_pubkey_b64?: string | null;
3416
3457
  /** Confirm Invite */
3417
3458
  confirm_invite?: boolean | null;
3459
+ /** Resource Type */
3460
+ resource_type?: ('document' | 'conversation') | null;
3461
+ /** Resource Ext Id */
3462
+ resource_ext_id?: string | null;
3463
+ /** Confirm Share */
3464
+ confirm_share?: boolean | null;
3418
3465
  };
3419
3466
  /**
3420
3467
  * AgentControlStateEvent
@@ -3565,7 +3612,7 @@ interface components {
3565
3612
  subagent_status?: ('running' | 'done' | 'failed') | null;
3566
3613
  /**
3567
3614
  * Task Message Ext Id
3568
- * @description The persisted branch this sub-agent's run lives in (a role='user' message in the SAME conversation, see subagent_conversation.py) — absent when the delegation type doesn't persist one (deep_research/run_skill/spawn_coding_agent stay ephemeral/inline-only). Lets the frontend jump into the thread via branch navigation instead of only reading the lane.
3615
+ * @description The persisted branch this sub-agent's run lives in (a role='user' message in the SAME conversation, see subagent_conversation.py) — every delegation persists one (sub_agent, deep_research, run_skill, spawn_coding_agent are all the same underlying mechanism). Lets the frontend jump into the thread via branch navigation instead of only reading the lane.
3569
3616
  */
3570
3617
  task_message_ext_id?: string | null;
3571
3618
  /**
@@ -3677,7 +3724,7 @@ interface components {
3677
3724
  RUN_CODE_ENABLED: boolean;
3678
3725
  /**
3679
3726
  * Mcp Tools
3680
- * @description MCP tool names to enable from LiteLLM (e.g. ['read_wiki_contents', 'ask_question']).
3727
+ * @description MCP tool names to enable from LiteLLM (e.g. ['firecrawl_scrape', 'firecrawl_search']).
3681
3728
  * @default []
3682
3729
  */
3683
3730
  MCP_TOOLS: string[];
@@ -3950,7 +3997,7 @@ interface components {
3950
3997
  RUN_CODE_ENABLED: boolean;
3951
3998
  /**
3952
3999
  * Mcp Tools
3953
- * @description MCP tool names to enable from LiteLLM (e.g. ['read_wiki_contents', 'ask_question']).
4000
+ * @description MCP tool names to enable from LiteLLM (e.g. ['firecrawl_scrape', 'firecrawl_search']).
3954
4001
  * @default []
3955
4002
  */
3956
4003
  MCP_TOOLS: string[];
@@ -4581,7 +4628,7 @@ interface components {
4581
4628
  subagent_status?: ('running' | 'done' | 'failed') | null;
4582
4629
  /**
4583
4630
  * Task Message Ext Id
4584
- * @description The persisted branch this sub-agent's run lives in (a role='user' message in the SAME conversation, see subagent_conversation.py) — absent when the delegation type doesn't persist one (deep_research/run_skill/spawn_coding_agent stay ephemeral/inline-only). Lets the frontend jump into the thread via branch navigation instead of only reading the lane.
4631
+ * @description The persisted branch this sub-agent's run lives in (a role='user' message in the SAME conversation, see subagent_conversation.py) — every delegation persists one (sub_agent, deep_research, run_skill, spawn_coding_agent are all the same underlying mechanism). Lets the frontend jump into the thread via branch navigation instead of only reading the lane.
4585
4632
  */
4586
4633
  task_message_ext_id?: string | null;
4587
4634
  /**
@@ -5915,6 +5962,14 @@ interface components {
5915
5962
  tag_ext_ids: string[];
5916
5963
  citations?: components['schemas']['CitationSources'] | null;
5917
5964
  };
5965
+ /**
5966
+ * CreateFactsRequest
5967
+ * @description Create several facts in one transaction (all-or-nothing).
5968
+ */
5969
+ CreateFactsRequest: {
5970
+ /** Facts */
5971
+ facts: components['schemas']['CreateFactRequest'][];
5972
+ };
5918
5973
  /**
5919
5974
  * CreatePlanDetail
5920
5975
  * @description Detail for a create_plan tool call.
@@ -6837,6 +6892,12 @@ interface components {
6837
6892
  confirmed: boolean;
6838
6893
  /** Score */
6839
6894
  score: number;
6895
+ citations?: components['schemas']['CitationSources'] | null;
6896
+ /**
6897
+ * Tags
6898
+ * @default []
6899
+ */
6900
+ tags: components['schemas']['FactTagResponse'][];
6840
6901
  };
6841
6902
  /**
6842
6903
  * FactSearchRequest
@@ -10246,6 +10307,8 @@ interface components {
10246
10307
  access: string;
10247
10308
  /** Refresh */
10248
10309
  refresh?: string | null;
10310
+ /** Auto Sync Workspace Ext Id */
10311
+ auto_sync_workspace_ext_id?: string | null;
10249
10312
  };
10250
10313
  /** ShareConversationResponse */
10251
10314
  ShareConversationResponse: {
@@ -14921,6 +14984,39 @@ interface operations {
14921
14984
  };
14922
14985
  };
14923
14986
  };
14987
+ create_facts_batch: {
14988
+ parameters: {
14989
+ query?: never;
14990
+ header?: never;
14991
+ path?: never;
14992
+ cookie?: never;
14993
+ };
14994
+ requestBody: {
14995
+ content: {
14996
+ 'application/json': components['schemas']['CreateFactsRequest'];
14997
+ };
14998
+ };
14999
+ responses: {
15000
+ /** @description Successful Response */
15001
+ 200: {
15002
+ headers: {
15003
+ [name: string]: unknown;
15004
+ };
15005
+ content: {
15006
+ 'application/json': components['schemas']['FactResponse'][];
15007
+ };
15008
+ };
15009
+ /** @description Validation Error */
15010
+ 422: {
15011
+ headers: {
15012
+ [name: string]: unknown;
15013
+ };
15014
+ content: {
15015
+ 'application/json': components['schemas']['HTTPValidationError'];
15016
+ };
15017
+ };
15018
+ };
15019
+ };
14924
15020
  list_facts: {
14925
15021
  parameters: {
14926
15022
  query?: {
@@ -14931,6 +15027,14 @@ interface operations {
14931
15027
  date_to?: string | null;
14932
15028
  /** @description Only facts that carry a date — the timeline view */
14933
15029
  dated_only?: boolean;
15030
+ /** @description Only facts carrying ALL of these tags */
15031
+ tag_ext_id?: string[] | null;
15032
+ /** @description Only facts whose sources include this document */
15033
+ doc_ext_id?: string | null;
15034
+ /** @description Page size; omit for every matching fact */
15035
+ limit?: number | null;
15036
+ /** @description Facts to skip, for paging with limit */
15037
+ offset?: number;
14934
15038
  };
14935
15039
  header?: never;
14936
15040
  path?: never;
package/dist/index.d.ts CHANGED
@@ -1988,6 +1988,30 @@ interface paths {
1988
1988
  patch?: never;
1989
1989
  trace?: never;
1990
1990
  };
1991
+ '/v1/facts/batch': {
1992
+ parameters: {
1993
+ query?: never;
1994
+ header?: never;
1995
+ path?: never;
1996
+ cookie?: never;
1997
+ };
1998
+ get?: never;
1999
+ put?: never;
2000
+ /**
2001
+ * Create Facts Batch Endpoint
2002
+ * @description Create several facts in one transaction — all of them, or none.
2003
+ *
2004
+ * Prefer this to a loop of single creates for an import: tags are resolved once and the facts are
2005
+ * embedded in batches after the commit, rather than one request, one tag lookup and one background
2006
+ * embedding task per fact. Responses come back in request order.
2007
+ */
2008
+ post: operations['create_facts_batch'];
2009
+ delete?: never;
2010
+ options?: never;
2011
+ head?: never;
2012
+ patch?: never;
2013
+ trace?: never;
2014
+ };
1991
2015
  '/v1/facts/list': {
1992
2016
  parameters: {
1993
2017
  query?: never;
@@ -2003,6 +2027,9 @@ interface paths {
2003
2027
  * into the timeline: only dated facts, ordered by when they happened. Each
2004
2028
  * bound is read at its own precision and widened outward, so ``date_to=2019``
2005
2029
  * runs through 31 December rather than stopping on 1 January.
2030
+ *
2031
+ * Narrow with ``tag_ext_id`` (repeatable; a fact must carry all of them) and ``doc_ext_id``, and page
2032
+ * with ``limit``/``offset`` — a large workspace need not be fetched whole.
2006
2033
  */
2007
2034
  get: operations['list_facts'];
2008
2035
  put?: never;
@@ -3401,6 +3428,20 @@ interface components {
3401
3428
  * follow-up call with this set to true for those specific emails actually sends the
3402
3429
  * invite and deposits the pending workspace-share grant. Without this gate, sharing
3403
3430
  * would email and grant future access to a typo'd address with no chance to back out.
3431
+ *
3432
+ * resource_type + resource_ext_id (optional): set when this call came from sharing a
3433
+ * specific document or conversation by email rather than the workspace itself (the
3434
+ * "Share" action on a resource). Every recipient still goes through the normal
3435
+ * add-user flow above (same role, same confirm_invite gate) — this only attaches a
3436
+ * breadcrumb so the invite/notification carries a deep link to the resource instead
3437
+ * of just the workspace, and Contacts.shared_resource_* survives an unregistered
3438
+ * recipient's registration so their first login redirects straight there.
3439
+ *
3440
+ * confirm_share (default False): required when the named resource is currently
3441
+ * private — sharing it externally makes it visible to every workspace member, not
3442
+ * just the recipients, so this mirrors confirm_invite's explicit-opt-in gate. A call
3443
+ * naming a private resource without this set does nothing and reports that a
3444
+ * confirmation is needed; the caller re-calls with it set once the owner confirms.
3404
3445
  */
3405
3446
  AddWorkspaceUsersRequest: {
3406
3447
  /** Emails */
@@ -3415,6 +3456,12 @@ interface components {
3415
3456
  session_pubkey_b64?: string | null;
3416
3457
  /** Confirm Invite */
3417
3458
  confirm_invite?: boolean | null;
3459
+ /** Resource Type */
3460
+ resource_type?: ('document' | 'conversation') | null;
3461
+ /** Resource Ext Id */
3462
+ resource_ext_id?: string | null;
3463
+ /** Confirm Share */
3464
+ confirm_share?: boolean | null;
3418
3465
  };
3419
3466
  /**
3420
3467
  * AgentControlStateEvent
@@ -3565,7 +3612,7 @@ interface components {
3565
3612
  subagent_status?: ('running' | 'done' | 'failed') | null;
3566
3613
  /**
3567
3614
  * Task Message Ext Id
3568
- * @description The persisted branch this sub-agent's run lives in (a role='user' message in the SAME conversation, see subagent_conversation.py) — absent when the delegation type doesn't persist one (deep_research/run_skill/spawn_coding_agent stay ephemeral/inline-only). Lets the frontend jump into the thread via branch navigation instead of only reading the lane.
3615
+ * @description The persisted branch this sub-agent's run lives in (a role='user' message in the SAME conversation, see subagent_conversation.py) — every delegation persists one (sub_agent, deep_research, run_skill, spawn_coding_agent are all the same underlying mechanism). Lets the frontend jump into the thread via branch navigation instead of only reading the lane.
3569
3616
  */
3570
3617
  task_message_ext_id?: string | null;
3571
3618
  /**
@@ -3677,7 +3724,7 @@ interface components {
3677
3724
  RUN_CODE_ENABLED: boolean;
3678
3725
  /**
3679
3726
  * Mcp Tools
3680
- * @description MCP tool names to enable from LiteLLM (e.g. ['read_wiki_contents', 'ask_question']).
3727
+ * @description MCP tool names to enable from LiteLLM (e.g. ['firecrawl_scrape', 'firecrawl_search']).
3681
3728
  * @default []
3682
3729
  */
3683
3730
  MCP_TOOLS: string[];
@@ -3950,7 +3997,7 @@ interface components {
3950
3997
  RUN_CODE_ENABLED: boolean;
3951
3998
  /**
3952
3999
  * Mcp Tools
3953
- * @description MCP tool names to enable from LiteLLM (e.g. ['read_wiki_contents', 'ask_question']).
4000
+ * @description MCP tool names to enable from LiteLLM (e.g. ['firecrawl_scrape', 'firecrawl_search']).
3954
4001
  * @default []
3955
4002
  */
3956
4003
  MCP_TOOLS: string[];
@@ -4581,7 +4628,7 @@ interface components {
4581
4628
  subagent_status?: ('running' | 'done' | 'failed') | null;
4582
4629
  /**
4583
4630
  * Task Message Ext Id
4584
- * @description The persisted branch this sub-agent's run lives in (a role='user' message in the SAME conversation, see subagent_conversation.py) — absent when the delegation type doesn't persist one (deep_research/run_skill/spawn_coding_agent stay ephemeral/inline-only). Lets the frontend jump into the thread via branch navigation instead of only reading the lane.
4631
+ * @description The persisted branch this sub-agent's run lives in (a role='user' message in the SAME conversation, see subagent_conversation.py) — every delegation persists one (sub_agent, deep_research, run_skill, spawn_coding_agent are all the same underlying mechanism). Lets the frontend jump into the thread via branch navigation instead of only reading the lane.
4585
4632
  */
4586
4633
  task_message_ext_id?: string | null;
4587
4634
  /**
@@ -5915,6 +5962,14 @@ interface components {
5915
5962
  tag_ext_ids: string[];
5916
5963
  citations?: components['schemas']['CitationSources'] | null;
5917
5964
  };
5965
+ /**
5966
+ * CreateFactsRequest
5967
+ * @description Create several facts in one transaction (all-or-nothing).
5968
+ */
5969
+ CreateFactsRequest: {
5970
+ /** Facts */
5971
+ facts: components['schemas']['CreateFactRequest'][];
5972
+ };
5918
5973
  /**
5919
5974
  * CreatePlanDetail
5920
5975
  * @description Detail for a create_plan tool call.
@@ -6837,6 +6892,12 @@ interface components {
6837
6892
  confirmed: boolean;
6838
6893
  /** Score */
6839
6894
  score: number;
6895
+ citations?: components['schemas']['CitationSources'] | null;
6896
+ /**
6897
+ * Tags
6898
+ * @default []
6899
+ */
6900
+ tags: components['schemas']['FactTagResponse'][];
6840
6901
  };
6841
6902
  /**
6842
6903
  * FactSearchRequest
@@ -10246,6 +10307,8 @@ interface components {
10246
10307
  access: string;
10247
10308
  /** Refresh */
10248
10309
  refresh?: string | null;
10310
+ /** Auto Sync Workspace Ext Id */
10311
+ auto_sync_workspace_ext_id?: string | null;
10249
10312
  };
10250
10313
  /** ShareConversationResponse */
10251
10314
  ShareConversationResponse: {
@@ -14921,6 +14984,39 @@ interface operations {
14921
14984
  };
14922
14985
  };
14923
14986
  };
14987
+ create_facts_batch: {
14988
+ parameters: {
14989
+ query?: never;
14990
+ header?: never;
14991
+ path?: never;
14992
+ cookie?: never;
14993
+ };
14994
+ requestBody: {
14995
+ content: {
14996
+ 'application/json': components['schemas']['CreateFactsRequest'];
14997
+ };
14998
+ };
14999
+ responses: {
15000
+ /** @description Successful Response */
15001
+ 200: {
15002
+ headers: {
15003
+ [name: string]: unknown;
15004
+ };
15005
+ content: {
15006
+ 'application/json': components['schemas']['FactResponse'][];
15007
+ };
15008
+ };
15009
+ /** @description Validation Error */
15010
+ 422: {
15011
+ headers: {
15012
+ [name: string]: unknown;
15013
+ };
15014
+ content: {
15015
+ 'application/json': components['schemas']['HTTPValidationError'];
15016
+ };
15017
+ };
15018
+ };
15019
+ };
14924
15020
  list_facts: {
14925
15021
  parameters: {
14926
15022
  query?: {
@@ -14931,6 +15027,14 @@ interface operations {
14931
15027
  date_to?: string | null;
14932
15028
  /** @description Only facts that carry a date — the timeline view */
14933
15029
  dated_only?: boolean;
15030
+ /** @description Only facts carrying ALL of these tags */
15031
+ tag_ext_id?: string[] | null;
15032
+ /** @description Only facts whose sources include this document */
15033
+ doc_ext_id?: string | null;
15034
+ /** @description Page size; omit for every matching fact */
15035
+ limit?: number | null;
15036
+ /** @description Facts to skip, for paging with limit */
15037
+ offset?: number;
14934
15038
  };
14935
15039
  header?: never;
14936
15040
  path?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@arbidocs/client",
3
- "version": "0.3.182",
3
+ "version": "0.3.183",
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",