@breign/client 1.0.129 → 1.0.130

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/openapi.json CHANGED
@@ -78,6 +78,9 @@
78
78
  }, {
79
79
  "description" : "OpenAI-compatible inference gateway endpoints",
80
80
  "name" : "ai-gateway"
81
+ }, {
82
+ "description" : "Super-admin only endpoints",
83
+ "name" : "admin"
81
84
  } ],
82
85
  "paths" : {
83
86
  "/health" : {
@@ -12763,6 +12766,279 @@
12763
12766
  "summary" : "Create a chat completion using the native OpenAI client",
12764
12767
  "tags" : [ "ai-gateway" ]
12765
12768
  }
12769
+ },
12770
+ "/admin/tool-presets" : {
12771
+ "delete" : {
12772
+ "description" : "Clears the shared tool library",
12773
+ "operationId" : "deleteAllAdminToolPresets",
12774
+ "responses" : {
12775
+ "200" : {
12776
+ "content" : {
12777
+ "application/json" : {
12778
+ "schema" : {
12779
+ "$ref" : "#/components/schemas/ToolPresetDeleteAllResponse"
12780
+ }
12781
+ }
12782
+ },
12783
+ "description" : "Tool library cleared"
12784
+ },
12785
+ "401" : {
12786
+ "description" : "Unauthorized"
12787
+ },
12788
+ "403" : {
12789
+ "description" : "Forbidden"
12790
+ }
12791
+ },
12792
+ "summary" : "Delete every tool preset",
12793
+ "tags" : [ "admin" ]
12794
+ },
12795
+ "get" : {
12796
+ "description" : "Returns a page of the shared tool library, including inactive presets. Use /admin/tool-presets/export to retrieve the whole library at once.",
12797
+ "operationId" : "getAdminToolPresets",
12798
+ "parameters" : [ {
12799
+ "description" : "Page number, starting at 1",
12800
+ "in" : "query",
12801
+ "name" : "page",
12802
+ "schema" : {
12803
+ "default" : 1,
12804
+ "minimum" : 1,
12805
+ "type" : "integer"
12806
+ }
12807
+ }, {
12808
+ "description" : "Maximum number of tool presets to return",
12809
+ "in" : "query",
12810
+ "name" : "limit",
12811
+ "schema" : {
12812
+ "default" : 25,
12813
+ "maximum" : 100,
12814
+ "minimum" : 1,
12815
+ "type" : "integer"
12816
+ }
12817
+ }, {
12818
+ "description" : "Search tool presets by name, slug, url or description",
12819
+ "in" : "query",
12820
+ "name" : "search",
12821
+ "schema" : {
12822
+ "type" : "string"
12823
+ }
12824
+ }, {
12825
+ "description" : "Filter tool presets by category",
12826
+ "in" : "query",
12827
+ "name" : "category",
12828
+ "schema" : {
12829
+ "type" : "string"
12830
+ }
12831
+ } ],
12832
+ "responses" : {
12833
+ "200" : {
12834
+ "content" : {
12835
+ "application/json" : {
12836
+ "schema" : {
12837
+ "$ref" : "#/components/schemas/ToolPresetPage"
12838
+ }
12839
+ }
12840
+ },
12841
+ "description" : "Tool presets retrieved successfully"
12842
+ },
12843
+ "401" : {
12844
+ "description" : "Unauthorized"
12845
+ },
12846
+ "403" : {
12847
+ "description" : "Forbidden"
12848
+ }
12849
+ },
12850
+ "summary" : "List tool presets",
12851
+ "tags" : [ "admin" ]
12852
+ },
12853
+ "post" : {
12854
+ "operationId" : "createAdminToolPreset",
12855
+ "requestBody" : {
12856
+ "content" : {
12857
+ "application/json" : {
12858
+ "schema" : {
12859
+ "$ref" : "#/components/schemas/ToolPresetCreateRequest"
12860
+ }
12861
+ }
12862
+ },
12863
+ "required" : true
12864
+ },
12865
+ "responses" : {
12866
+ "201" : {
12867
+ "content" : {
12868
+ "application/json" : {
12869
+ "schema" : {
12870
+ "$ref" : "#/components/schemas/ToolPreset"
12871
+ }
12872
+ }
12873
+ },
12874
+ "description" : "Tool preset created"
12875
+ },
12876
+ "400" : {
12877
+ "description" : "Invalid payload"
12878
+ },
12879
+ "401" : {
12880
+ "description" : "Unauthorized"
12881
+ },
12882
+ "403" : {
12883
+ "description" : "Forbidden"
12884
+ },
12885
+ "409" : {
12886
+ "description" : "TOOL_PRESET_SLUG_ALREADY_EXISTS"
12887
+ }
12888
+ },
12889
+ "summary" : "Create a tool preset",
12890
+ "tags" : [ "admin" ]
12891
+ }
12892
+ },
12893
+ "/admin/tool-presets/export" : {
12894
+ "get" : {
12895
+ "description" : "Returns the whole shared tool library at once, without pagination. The payload can be fed back as-is to /admin/tool-presets/import.",
12896
+ "operationId" : "exportAdminToolPresets",
12897
+ "responses" : {
12898
+ "200" : {
12899
+ "content" : {
12900
+ "application/json" : {
12901
+ "schema" : {
12902
+ "items" : {
12903
+ "$ref" : "#/components/schemas/ToolPreset"
12904
+ },
12905
+ "type" : "array"
12906
+ }
12907
+ }
12908
+ },
12909
+ "description" : "Tool library exported successfully"
12910
+ },
12911
+ "401" : {
12912
+ "description" : "Unauthorized"
12913
+ },
12914
+ "403" : {
12915
+ "description" : "Forbidden"
12916
+ }
12917
+ },
12918
+ "summary" : "Export every tool preset",
12919
+ "tags" : [ "admin" ]
12920
+ }
12921
+ },
12922
+ "/admin/tool-presets/import" : {
12923
+ "post" : {
12924
+ "description" : "Replaces the presets that already exist (matched on their slug) and adds the new ones. Presets absent from the payload are left untouched.",
12925
+ "operationId" : "importAdminToolPresets",
12926
+ "requestBody" : {
12927
+ "content" : {
12928
+ "application/json" : {
12929
+ "schema" : {
12930
+ "$ref" : "#/components/schemas/ToolPresetImportRequest"
12931
+ }
12932
+ }
12933
+ },
12934
+ "required" : true
12935
+ },
12936
+ "responses" : {
12937
+ "200" : {
12938
+ "content" : {
12939
+ "application/json" : {
12940
+ "schema" : {
12941
+ "$ref" : "#/components/schemas/ToolPresetImportResponse"
12942
+ }
12943
+ }
12944
+ },
12945
+ "description" : "Import completed"
12946
+ },
12947
+ "400" : {
12948
+ "description" : "Invalid payload or duplicated slug"
12949
+ },
12950
+ "401" : {
12951
+ "description" : "Unauthorized"
12952
+ },
12953
+ "403" : {
12954
+ "description" : "Forbidden"
12955
+ }
12956
+ },
12957
+ "summary" : "Import tool presets",
12958
+ "tags" : [ "admin" ]
12959
+ }
12960
+ },
12961
+ "/admin/tool-presets/{toolPresetId}" : {
12962
+ "delete" : {
12963
+ "operationId" : "deleteAdminToolPreset",
12964
+ "parameters" : [ {
12965
+ "description" : "Tool preset identifier",
12966
+ "in" : "path",
12967
+ "name" : "toolPresetId",
12968
+ "required" : true,
12969
+ "schema" : {
12970
+ "type" : "string"
12971
+ }
12972
+ } ],
12973
+ "responses" : {
12974
+ "204" : {
12975
+ "description" : "Deleted"
12976
+ },
12977
+ "401" : {
12978
+ "description" : "Unauthorized"
12979
+ },
12980
+ "403" : {
12981
+ "description" : "Forbidden"
12982
+ },
12983
+ "404" : {
12984
+ "description" : "TOOL_PRESET_NOT_FOUND"
12985
+ }
12986
+ },
12987
+ "summary" : "Delete a tool preset",
12988
+ "tags" : [ "admin" ]
12989
+ },
12990
+ "put" : {
12991
+ "description" : "Partial update — only the provided properties are modified",
12992
+ "operationId" : "updateAdminToolPreset",
12993
+ "parameters" : [ {
12994
+ "description" : "Tool preset identifier",
12995
+ "in" : "path",
12996
+ "name" : "toolPresetId",
12997
+ "required" : true,
12998
+ "schema" : {
12999
+ "type" : "string"
13000
+ }
13001
+ } ],
13002
+ "requestBody" : {
13003
+ "content" : {
13004
+ "application/json" : {
13005
+ "schema" : {
13006
+ "$ref" : "#/components/schemas/ToolPresetUpdateRequest"
13007
+ }
13008
+ }
13009
+ },
13010
+ "required" : true
13011
+ },
13012
+ "responses" : {
13013
+ "200" : {
13014
+ "content" : {
13015
+ "application/json" : {
13016
+ "schema" : {
13017
+ "$ref" : "#/components/schemas/ToolPreset"
13018
+ }
13019
+ }
13020
+ },
13021
+ "description" : "Tool preset updated"
13022
+ },
13023
+ "400" : {
13024
+ "description" : "Invalid payload"
13025
+ },
13026
+ "401" : {
13027
+ "description" : "Unauthorized"
13028
+ },
13029
+ "403" : {
13030
+ "description" : "Forbidden"
13031
+ },
13032
+ "404" : {
13033
+ "description" : "TOOL_PRESET_NOT_FOUND"
13034
+ },
13035
+ "409" : {
13036
+ "description" : "TOOL_PRESET_SLUG_ALREADY_EXISTS"
13037
+ }
13038
+ },
13039
+ "summary" : "Update a tool preset",
13040
+ "tags" : [ "admin" ]
13041
+ }
12766
13042
  }
12767
13043
  },
12768
13044
  "components" : {
@@ -13322,6 +13598,15 @@
13322
13598
  "schema" : {
13323
13599
  "type" : "string"
13324
13600
  }
13601
+ },
13602
+ "toolPresetIdPath" : {
13603
+ "description" : "Tool preset identifier",
13604
+ "in" : "path",
13605
+ "name" : "toolPresetId",
13606
+ "required" : true,
13607
+ "schema" : {
13608
+ "type" : "string"
13609
+ }
13325
13610
  }
13326
13611
  },
13327
13612
  "schemas" : {
@@ -19356,6 +19641,339 @@
19356
19641
  },
19357
19642
  "type" : "object"
19358
19643
  },
19644
+ "ToolPresetPage" : {
19645
+ "properties" : {
19646
+ "data" : {
19647
+ "items" : {
19648
+ "$ref" : "#/components/schemas/ToolPreset"
19649
+ },
19650
+ "type" : "array"
19651
+ },
19652
+ "total" : {
19653
+ "description" : "Number of presets matching the filters",
19654
+ "type" : "integer"
19655
+ },
19656
+ "page" : {
19657
+ "type" : "integer"
19658
+ },
19659
+ "limit" : {
19660
+ "type" : "integer"
19661
+ },
19662
+ "totalPages" : {
19663
+ "type" : "integer"
19664
+ },
19665
+ "allCategories" : {
19666
+ "description" : "Every category of the library, regardless of the current filter",
19667
+ "items" : {
19668
+ "type" : "string"
19669
+ },
19670
+ "type" : "array"
19671
+ }
19672
+ },
19673
+ "required" : [ "allCategories", "data", "limit", "page", "total", "totalPages" ],
19674
+ "title" : "ToolPresetPage",
19675
+ "type" : "object"
19676
+ },
19677
+ "ToolPreset" : {
19678
+ "properties" : {
19679
+ "id" : {
19680
+ "format" : "uuid",
19681
+ "type" : "string"
19682
+ },
19683
+ "slug" : {
19684
+ "description" : "Unique identifier of the preset, used as the key on import",
19685
+ "type" : "string"
19686
+ },
19687
+ "name" : {
19688
+ "type" : "string"
19689
+ },
19690
+ "descriptionEn" : {
19691
+ "type" : "string"
19692
+ },
19693
+ "descriptionFr" : {
19694
+ "type" : "string"
19695
+ },
19696
+ "url" : {
19697
+ "description" : "MCP server URL",
19698
+ "type" : "string"
19699
+ },
19700
+ "logoUrl" : {
19701
+ "nullable" : true,
19702
+ "type" : "string"
19703
+ },
19704
+ "transport" : {
19705
+ "$ref" : "#/components/schemas/ToolPresetTransport"
19706
+ },
19707
+ "authMethods" : {
19708
+ "description" : "Supported authentication methods, e.g. none, bearer, oauth",
19709
+ "items" : {
19710
+ "type" : "string"
19711
+ },
19712
+ "type" : "array"
19713
+ },
19714
+ "oauthRegistration" : {
19715
+ "allOf" : [ {
19716
+ "$ref" : "#/components/schemas/ToolPresetOAuthRegistration"
19717
+ } ],
19718
+ "nullable" : true
19719
+ },
19720
+ "category" : {
19721
+ "description" : "Category key used to group presets",
19722
+ "type" : "string"
19723
+ },
19724
+ "categoryLabelEn" : {
19725
+ "type" : "string"
19726
+ },
19727
+ "categoryLabelFr" : {
19728
+ "type" : "string"
19729
+ },
19730
+ "categoryDescriptionEn" : {
19731
+ "type" : "string"
19732
+ },
19733
+ "categoryDescriptionFr" : {
19734
+ "type" : "string"
19735
+ },
19736
+ "isActive" : {
19737
+ "description" : "Only active presets are exposed to organizations",
19738
+ "type" : "boolean"
19739
+ },
19740
+ "createdAt" : {
19741
+ "format" : "date-time",
19742
+ "type" : "string"
19743
+ },
19744
+ "updatedAt" : {
19745
+ "format" : "date-time",
19746
+ "type" : "string"
19747
+ }
19748
+ },
19749
+ "required" : [ "authMethods", "category", "categoryDescriptionEn", "categoryDescriptionFr", "categoryLabelEn", "categoryLabelFr", "descriptionEn", "descriptionFr", "id", "isActive", "name", "slug", "transport", "url" ],
19750
+ "title" : "ToolPreset",
19751
+ "type" : "object"
19752
+ },
19753
+ "ToolPresetCreateRequest" : {
19754
+ "properties" : {
19755
+ "slug" : {
19756
+ "type" : "string"
19757
+ },
19758
+ "name" : {
19759
+ "type" : "string"
19760
+ },
19761
+ "descriptionEn" : {
19762
+ "type" : "string"
19763
+ },
19764
+ "descriptionFr" : {
19765
+ "type" : "string"
19766
+ },
19767
+ "url" : {
19768
+ "type" : "string"
19769
+ },
19770
+ "logoUrl" : {
19771
+ "nullable" : true,
19772
+ "type" : "string"
19773
+ },
19774
+ "transport" : {
19775
+ "$ref" : "#/components/schemas/ToolPresetTransport"
19776
+ },
19777
+ "authMethods" : {
19778
+ "items" : {
19779
+ "type" : "string"
19780
+ },
19781
+ "type" : "array"
19782
+ },
19783
+ "oauthRegistration" : {
19784
+ "allOf" : [ {
19785
+ "$ref" : "#/components/schemas/ToolPresetOAuthRegistration"
19786
+ } ],
19787
+ "nullable" : true
19788
+ },
19789
+ "category" : {
19790
+ "type" : "string"
19791
+ },
19792
+ "categoryLabelEn" : {
19793
+ "type" : "string"
19794
+ },
19795
+ "categoryLabelFr" : {
19796
+ "type" : "string"
19797
+ },
19798
+ "categoryDescriptionEn" : {
19799
+ "type" : "string"
19800
+ },
19801
+ "categoryDescriptionFr" : {
19802
+ "type" : "string"
19803
+ },
19804
+ "isActive" : {
19805
+ "type" : "boolean"
19806
+ }
19807
+ },
19808
+ "required" : [ "category", "name", "slug", "url" ],
19809
+ "title" : "ToolPresetCreateRequest",
19810
+ "type" : "object"
19811
+ },
19812
+ "ToolPresetDeleteAllResponse" : {
19813
+ "properties" : {
19814
+ "deleted" : {
19815
+ "description" : "Number of presets removed from the library",
19816
+ "type" : "integer"
19817
+ }
19818
+ },
19819
+ "required" : [ "deleted" ],
19820
+ "title" : "ToolPresetDeleteAllResponse",
19821
+ "type" : "object"
19822
+ },
19823
+ "ToolPresetImportRequest" : {
19824
+ "properties" : {
19825
+ "presets" : {
19826
+ "items" : {
19827
+ "$ref" : "#/components/schemas/ToolPresetImportItem"
19828
+ },
19829
+ "type" : "array"
19830
+ }
19831
+ },
19832
+ "required" : [ "presets" ],
19833
+ "title" : "ToolPresetImportRequest",
19834
+ "type" : "object"
19835
+ },
19836
+ "ToolPresetImportItem" : {
19837
+ "properties" : {
19838
+ "id" : {
19839
+ "type" : "string"
19840
+ },
19841
+ "createdAt" : {
19842
+ "type" : "string"
19843
+ },
19844
+ "updatedAt" : {
19845
+ "type" : "string"
19846
+ },
19847
+ "slug" : {
19848
+ "type" : "string"
19849
+ },
19850
+ "name" : {
19851
+ "type" : "string"
19852
+ },
19853
+ "descriptionEn" : {
19854
+ "type" : "string"
19855
+ },
19856
+ "descriptionFr" : {
19857
+ "type" : "string"
19858
+ },
19859
+ "url" : {
19860
+ "type" : "string"
19861
+ },
19862
+ "logoUrl" : {
19863
+ "nullable" : true,
19864
+ "type" : "string"
19865
+ },
19866
+ "transport" : {
19867
+ "$ref" : "#/components/schemas/ToolPresetTransport"
19868
+ },
19869
+ "authMethods" : {
19870
+ "items" : {
19871
+ "type" : "string"
19872
+ },
19873
+ "type" : "array"
19874
+ },
19875
+ "oauthRegistration" : {
19876
+ "allOf" : [ {
19877
+ "$ref" : "#/components/schemas/ToolPresetOAuthRegistration"
19878
+ } ],
19879
+ "nullable" : true
19880
+ },
19881
+ "category" : {
19882
+ "type" : "string"
19883
+ },
19884
+ "categoryLabelEn" : {
19885
+ "type" : "string"
19886
+ },
19887
+ "categoryLabelFr" : {
19888
+ "type" : "string"
19889
+ },
19890
+ "categoryDescriptionEn" : {
19891
+ "type" : "string"
19892
+ },
19893
+ "categoryDescriptionFr" : {
19894
+ "type" : "string"
19895
+ },
19896
+ "isActive" : {
19897
+ "type" : "boolean"
19898
+ }
19899
+ },
19900
+ "required" : [ "category", "name", "slug", "url" ],
19901
+ "title" : "ToolPresetImportItem",
19902
+ "type" : "object"
19903
+ },
19904
+ "ToolPresetImportResponse" : {
19905
+ "properties" : {
19906
+ "created" : {
19907
+ "description" : "Number of presets added",
19908
+ "type" : "integer"
19909
+ },
19910
+ "updated" : {
19911
+ "description" : "Number of existing presets replaced",
19912
+ "type" : "integer"
19913
+ }
19914
+ },
19915
+ "required" : [ "created", "updated" ],
19916
+ "title" : "ToolPresetImportResponse",
19917
+ "type" : "object"
19918
+ },
19919
+ "ToolPresetUpdateRequest" : {
19920
+ "properties" : {
19921
+ "slug" : {
19922
+ "type" : "string"
19923
+ },
19924
+ "name" : {
19925
+ "type" : "string"
19926
+ },
19927
+ "descriptionEn" : {
19928
+ "type" : "string"
19929
+ },
19930
+ "descriptionFr" : {
19931
+ "type" : "string"
19932
+ },
19933
+ "url" : {
19934
+ "type" : "string"
19935
+ },
19936
+ "logoUrl" : {
19937
+ "nullable" : true,
19938
+ "type" : "string"
19939
+ },
19940
+ "transport" : {
19941
+ "$ref" : "#/components/schemas/ToolPresetTransport"
19942
+ },
19943
+ "authMethods" : {
19944
+ "items" : {
19945
+ "type" : "string"
19946
+ },
19947
+ "type" : "array"
19948
+ },
19949
+ "oauthRegistration" : {
19950
+ "allOf" : [ {
19951
+ "$ref" : "#/components/schemas/ToolPresetOAuthRegistration"
19952
+ } ],
19953
+ "nullable" : true
19954
+ },
19955
+ "category" : {
19956
+ "type" : "string"
19957
+ },
19958
+ "categoryLabelEn" : {
19959
+ "type" : "string"
19960
+ },
19961
+ "categoryLabelFr" : {
19962
+ "type" : "string"
19963
+ },
19964
+ "categoryDescriptionEn" : {
19965
+ "type" : "string"
19966
+ },
19967
+ "categoryDescriptionFr" : {
19968
+ "type" : "string"
19969
+ },
19970
+ "isActive" : {
19971
+ "type" : "boolean"
19972
+ }
19973
+ },
19974
+ "title" : "ToolPresetUpdateRequest",
19975
+ "type" : "object"
19976
+ },
19359
19977
  "FileStatus" : {
19360
19978
  "enum" : [ "SCRAPING", "PENDING", "UPLOADED", "PROCESSING", "INDEXED" ],
19361
19979
  "type" : "string"
@@ -19574,6 +20192,14 @@
19574
20192
  "enum" : [ "ELEVENLABS" ],
19575
20193
  "type" : "string"
19576
20194
  },
20195
+ "ToolPresetTransport" : {
20196
+ "enum" : [ "http", "sse" ],
20197
+ "type" : "string"
20198
+ },
20199
+ "ToolPresetOAuthRegistration" : {
20200
+ "enum" : [ "auto", "client_id", "client_id_secret" ],
20201
+ "type" : "string"
20202
+ },
19577
20203
  "addModule_request" : {
19578
20204
  "additionalProperties" : false,
19579
20205
  "properties" : {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@breign/client",
3
- "version": "1.0.129",
3
+ "version": "1.0.130",
4
4
  "main": "dist/index.js",
5
5
  "exports": {
6
6
  ".": "./dist/index.js",