@faable/auth-sdk 2.5.8 → 2.5.10

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.
@@ -510,7 +510,7 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
510
510
  all: () => Promise<{
511
511
  id: string;
512
512
  connection_name: string;
513
- connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
513
+ connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "microsoft" | "oidc" | "passwordless_email";
514
514
  authorize_url: string;
515
515
  token_url: string;
516
516
  userinfo_url: string;
@@ -549,7 +549,7 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
549
549
  first: () => Promise<import("@faable/sdk-base/dist/helpers/paginator.js").Page<{
550
550
  id: string;
551
551
  connection_name: string;
552
- connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
552
+ connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "microsoft" | "oidc" | "passwordless_email";
553
553
  authorize_url: string;
554
554
  token_url: string;
555
555
  userinfo_url: string;
@@ -591,7 +591,7 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
591
591
  } | undefined) => Promise<import("@faable/sdk-base/dist/helpers/paginator.js").Page<{
592
592
  id: string;
593
593
  connection_name: string;
594
- connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
594
+ connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "microsoft" | "oidc" | "passwordless_email";
595
595
  authorize_url: string;
596
596
  token_url: string;
597
597
  userinfo_url: string;
@@ -632,7 +632,7 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
632
632
  getConection(...args: Parameters<GeneratedFaableAuthApi["connectionGet"]>): Promise<{
633
633
  id: string;
634
634
  connection_name: string;
635
- connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
635
+ connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "microsoft" | "oidc" | "passwordless_email";
636
636
  authorize_url: string;
637
637
  token_url: string;
638
638
  userinfo_url: string;
@@ -26,6 +26,7 @@ export type Connection = components["schemas"]["Connection"];
26
26
  export type ConnectionCreate = components["schemas"]["ConnectionCreate"];
27
27
  export type ConnectionMetadata = components["schemas"]["ConnectionMetadata"];
28
28
  export type ConnectionMetadataCreate = components["schemas"]["ConnectionMetadataCreate"];
29
+ export type ConnectionTypeInfo = components["schemas"]["ConnectionTypeInfo"];
29
30
  export type ConnectionUpdate = components["schemas"]["ConnectionUpdate"];
30
31
  export type Credential = components["schemas"]["Credential"];
31
32
  export type CredentialMetadata = components["schemas"]["CredentialMetadata"];
@@ -899,7 +899,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
899
899
  connectionCreate(data: OpBody<"connection/create">): Promise<{
900
900
  id: string;
901
901
  connection_name: string;
902
- connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
902
+ connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "microsoft" | "oidc" | "passwordless_email";
903
903
  authorize_url: string;
904
904
  token_url: string;
905
905
  userinfo_url: string;
@@ -943,7 +943,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
943
943
  connectionDelete(connection_id: string): Promise<{
944
944
  id: string;
945
945
  connection_name: string;
946
- connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
946
+ connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "microsoft" | "oidc" | "passwordless_email";
947
947
  authorize_url: string;
948
948
  token_url: string;
949
949
  userinfo_url: string;
@@ -987,7 +987,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
987
987
  connectionGet(connection_id: string): Promise<{
988
988
  id: string;
989
989
  connection_name: string;
990
- connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
990
+ connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "microsoft" | "oidc" | "passwordless_email";
991
991
  authorize_url: string;
992
992
  token_url: string;
993
993
  userinfo_url: string;
@@ -1032,7 +1032,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
1032
1032
  all: () => Promise<{
1033
1033
  id: string;
1034
1034
  connection_name: string;
1035
- connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
1035
+ connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "microsoft" | "oidc" | "passwordless_email";
1036
1036
  authorize_url: string;
1037
1037
  token_url: string;
1038
1038
  userinfo_url: string;
@@ -1071,7 +1071,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
1071
1071
  first: () => Promise<import("@faable/sdk-base/dist/helpers/paginator.js").Page<{
1072
1072
  id: string;
1073
1073
  connection_name: string;
1074
- connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
1074
+ connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "microsoft" | "oidc" | "passwordless_email";
1075
1075
  authorize_url: string;
1076
1076
  token_url: string;
1077
1077
  userinfo_url: string;
@@ -1113,7 +1113,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
1113
1113
  } | undefined) => Promise<import("@faable/sdk-base/dist/helpers/paginator.js").Page<{
1114
1114
  id: string;
1115
1115
  connection_name: string;
1116
- connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
1116
+ connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "microsoft" | "oidc" | "passwordless_email";
1117
1117
  authorize_url: string;
1118
1118
  token_url: string;
1119
1119
  userinfo_url: string;
@@ -1158,7 +1158,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
1158
1158
  connectionUpdate(connection_id: string, data: OpBody<"connection/update">): Promise<{
1159
1159
  id: string;
1160
1160
  connection_name: string;
1161
- connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
1161
+ connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "microsoft" | "oidc" | "passwordless_email";
1162
1162
  authorize_url: string;
1163
1163
  token_url: string;
1164
1164
  userinfo_url: string;
@@ -180,6 +180,26 @@ export interface paths {
180
180
  patch?: never;
181
181
  trace?: never;
182
182
  };
183
+ "/connection-types": {
184
+ parameters: {
185
+ query?: never;
186
+ header?: never;
187
+ path?: never;
188
+ cookie?: never;
189
+ };
190
+ /**
191
+ * List supported connection types
192
+ * @description Returns the catalog of connection types this server supports, with the presentation metadata a UI needs (label, icon slug, category) and two derived capability flags: whether the provider comes preconfigured and whether Faable ships shared credentials for it. Public: contains no URLs and no credentials. Changes only between server releases — cache it.
193
+ */
194
+ get: operations["connection/types"];
195
+ put?: never;
196
+ post?: never;
197
+ delete?: never;
198
+ options?: never;
199
+ head?: never;
200
+ patch?: never;
201
+ trace?: never;
202
+ };
183
203
  "/client": {
184
204
  parameters: {
185
205
  query?: never;
@@ -1719,7 +1739,7 @@ export interface components {
1719
1739
  id: string;
1720
1740
  connection_name: string;
1721
1741
  /** @enum {unknown} */
1722
- connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
1742
+ connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "microsoft" | "oidc" | "passwordless_email";
1723
1743
  /** @default null */
1724
1744
  authorize_url: string;
1725
1745
  /** @default null */
@@ -1791,7 +1811,7 @@ export interface components {
1791
1811
  ConnectionCreate: {
1792
1812
  connection_name: string;
1793
1813
  /** @enum {unknown} */
1794
- connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
1814
+ connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "microsoft" | "oidc" | "passwordless_email";
1795
1815
  authorize_url?: string;
1796
1816
  client_id?: string;
1797
1817
  client_secret?: string;
@@ -1870,6 +1890,29 @@ export interface components {
1870
1890
  } | null;
1871
1891
  disable_signup?: boolean;
1872
1892
  };
1893
+ /** @description Presentation metadata for one connection type. Contains no endpoint URLs and no credentials. */
1894
+ ConnectionTypeInfo: {
1895
+ /** @enum {unknown} */
1896
+ type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "microsoft" | "oidc" | "passwordless_email";
1897
+ /** @description Brand name for this provider. Not translatable — "GitHub" is "GitHub" in every locale. */
1898
+ label: string;
1899
+ /** @description Stable icon slug (e.g. `github`, `google`, `microsoft`). Clients map it to their own icon set; it is not a URL. */
1900
+ icon: string;
1901
+ /**
1902
+ * @description Grouping this type belongs to. Matches the `?query=category:<value>` filter on GET /connection.
1903
+ * @enum {string}
1904
+ */
1905
+ category: "database" | "social" | "passwordless" | "oidc";
1906
+ /** @description The server preconfigures this provider's OAuth2 endpoints, so a tenant only supplies credentials. False for `custom` (bring your own URLs) and for non-OAuth types. */
1907
+ configured_provider: boolean;
1908
+ /** @description Faable ships a shared OAuth app for this provider, so a tenant can enable it without registering anything of its own. */
1909
+ supports_default_credentials: boolean;
1910
+ /** @description Provider documentation for tenants registering their own OAuth app. */
1911
+ docs?: {
1912
+ label: string;
1913
+ url: string;
1914
+ };
1915
+ };
1873
1916
  /** @description Client */
1874
1917
  Client: {
1875
1918
  /** @description Client ID */
@@ -3749,7 +3792,7 @@ export interface operations {
3749
3792
  "application/json": {
3750
3793
  connection_name: string;
3751
3794
  /** @enum {unknown} */
3752
- connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
3795
+ connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "microsoft" | "oidc" | "passwordless_email";
3753
3796
  authorize_url?: string;
3754
3797
  client_id?: string;
3755
3798
  client_secret?: string;
@@ -3803,7 +3846,7 @@ export interface operations {
3803
3846
  id: string;
3804
3847
  connection_name: string;
3805
3848
  /** @enum {unknown} */
3806
- connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
3849
+ connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "microsoft" | "oidc" | "passwordless_email";
3807
3850
  /** @default null */
3808
3851
  authorize_url: string;
3809
3852
  /** @default null */
@@ -3890,7 +3933,7 @@ export interface operations {
3890
3933
  id: string;
3891
3934
  connection_name: string;
3892
3935
  /** @enum {unknown} */
3893
- connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
3936
+ connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "microsoft" | "oidc" | "passwordless_email";
3894
3937
  /** @default null */
3895
3938
  authorize_url: string;
3896
3939
  /** @default null */
@@ -4015,7 +4058,7 @@ export interface operations {
4015
4058
  id: string;
4016
4059
  connection_name: string;
4017
4060
  /** @enum {unknown} */
4018
- connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
4061
+ connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "microsoft" | "oidc" | "passwordless_email";
4019
4062
  /** @default null */
4020
4063
  authorize_url: string;
4021
4064
  /** @default null */
@@ -4102,7 +4145,7 @@ export interface operations {
4102
4145
  id: string;
4103
4146
  connection_name: string;
4104
4147
  /** @enum {unknown} */
4105
- connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
4148
+ connection_type: "database" | "custom" | "github" | "figma" | "google_oauth2" | "microsoft" | "oidc" | "passwordless_email";
4106
4149
  /** @default null */
4107
4150
  authorize_url: string;
4108
4151
  /** @default null */
@@ -4167,6 +4210,26 @@ export interface operations {
4167
4210
  };
4168
4211
  };
4169
4212
  };
4213
+ "connection/types": {
4214
+ parameters: {
4215
+ query?: never;
4216
+ header?: never;
4217
+ path?: never;
4218
+ cookie?: never;
4219
+ };
4220
+ requestBody?: never;
4221
+ responses: {
4222
+ /** @description Default Response */
4223
+ 200: {
4224
+ headers: {
4225
+ [name: string]: unknown;
4226
+ };
4227
+ content: {
4228
+ "application/json": components["schemas"]["ConnectionTypeInfo"][];
4229
+ };
4230
+ };
4231
+ };
4232
+ };
4170
4233
  "client/list": {
4171
4234
  parameters: {
4172
4235
  query?: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@faable/auth-sdk",
3
- "version": "2.5.8",
3
+ "version": "2.5.10",
4
4
  "author": "Marc Pomar <marc@faable.com>",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/spec/openapi.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "info": {
4
4
  "title": "@faablecloud/auth",
5
5
  "description": "Auth Platform made by Faable. Manage Users and Roles",
6
- "version": "1.31.4",
6
+ "version": "1.33.0",
7
7
  "license": {
8
8
  "name": "private",
9
9
  "url": "https://faable.com/docs/platform/privacy-policy"
@@ -271,6 +271,7 @@
271
271
  "github",
272
272
  "figma",
273
273
  "google_oauth2",
274
+ "microsoft",
274
275
  "oidc",
275
276
  "passwordless_email"
276
277
  ]
@@ -471,6 +472,7 @@
471
472
  "github",
472
473
  "figma",
473
474
  "google_oauth2",
475
+ "microsoft",
474
476
  "oidc",
475
477
  "passwordless_email"
476
478
  ]
@@ -761,6 +763,75 @@
761
763
  "description": "Partial update for a Connection. Only the supplied fields are modified. `connection_type` is intentionally excluded — changing it would orphan every identity already linked to this connection.",
762
764
  "additionalProperties": false
763
765
  },
766
+ "ConnectionTypeInfo": {
767
+ "type": "object",
768
+ "required": [
769
+ "type",
770
+ "label",
771
+ "icon",
772
+ "category",
773
+ "configured_provider",
774
+ "supports_default_credentials"
775
+ ],
776
+ "properties": {
777
+ "type": {
778
+ "enum": [
779
+ "database",
780
+ "custom",
781
+ "github",
782
+ "figma",
783
+ "google_oauth2",
784
+ "microsoft",
785
+ "oidc",
786
+ "passwordless_email"
787
+ ]
788
+ },
789
+ "label": {
790
+ "type": "string",
791
+ "description": "Brand name for this provider. Not translatable — \"GitHub\" is \"GitHub\" in every locale."
792
+ },
793
+ "icon": {
794
+ "type": "string",
795
+ "description": "Stable icon slug (e.g. `github`, `google`, `microsoft`). Clients map it to their own icon set; it is not a URL."
796
+ },
797
+ "category": {
798
+ "type": "string",
799
+ "enum": [
800
+ "database",
801
+ "social",
802
+ "passwordless",
803
+ "oidc"
804
+ ],
805
+ "description": "Grouping this type belongs to. Matches the `?query=category:<value>` filter on GET /connection."
806
+ },
807
+ "configured_provider": {
808
+ "type": "boolean",
809
+ "description": "The server preconfigures this provider's OAuth2 endpoints, so a tenant only supplies credentials. False for `custom` (bring your own URLs) and for non-OAuth types."
810
+ },
811
+ "supports_default_credentials": {
812
+ "type": "boolean",
813
+ "description": "Faable ships a shared OAuth app for this provider, so a tenant can enable it without registering anything of its own."
814
+ },
815
+ "docs": {
816
+ "type": "object",
817
+ "required": [
818
+ "label",
819
+ "url"
820
+ ],
821
+ "properties": {
822
+ "label": {
823
+ "type": "string"
824
+ },
825
+ "url": {
826
+ "type": "string"
827
+ }
828
+ },
829
+ "description": "Provider documentation for tenants registering their own OAuth app."
830
+ }
831
+ },
832
+ "description": "Presentation metadata for one connection type. Contains no endpoint URLs and no credentials.",
833
+ "additionalProperties": false
834
+ },
764
835
  "Client": {
765
836
  "type": "object",
766
837
  "required": [
@@ -5623,6 +5694,7 @@
5623
5694
  "github",
5624
5695
  "figma",
5625
5696
  "google_oauth2",
5697
+ "microsoft",
5626
5698
  "oidc",
5627
5699
  "passwordless_email"
5628
5700
  ]
@@ -5806,6 +5878,7 @@
5806
5878
  "github",
5807
5879
  "figma",
5808
5880
  "google_oauth2",
5881
+ "microsoft",
5809
5882
  "oidc",
5810
5883
  "passwordless_email"
5811
5884
  ]
@@ -6053,6 +6126,7 @@
6053
6126
  "github",
6054
6127
  "figma",
6055
6128
  "google_oauth2",
6129
+ "microsoft",
6056
6130
  "oidc",
6057
6131
  "passwordless_email"
6058
6132
  ]
@@ -6458,6 +6532,7 @@
6458
6532
  "github",
6459
6533
  "figma",
6460
6534
  "google_oauth2",
6535
+ "microsoft",
6461
6536
  "oidc",
6462
6537
  "passwordless_email"
6463
6538
  ]
@@ -6703,6 +6778,7 @@
6703
6778
  "github",
6704
6779
  "figma",
6705
6780
  "google_oauth2",
6781
+ "microsoft",
6706
6782
  "oidc",
6707
6783
  "passwordless_email"
6708
6784
  ]
@@ -6885,6 +6961,31 @@
6885
6961
  }
6886
6962
  }
6887
6963
  },
6964
+ "/connection-types": {
6965
+ "get": {
6966
+ "operationId": "connection/types",
6967
+ "summary": "List supported connection types",
6968
+ "tags": [
6969
+ "connection"
6970
+ ],
6971
+ "description": "Returns the catalog of connection types this server supports, with the presentation metadata a UI needs (label, icon slug, category) and two derived capability flags: whether the provider comes preconfigured and whether Faable ships shared credentials for it. Public: contains no URLs and no credentials. Changes only between server releases — cache it.",
6972
+ "responses": {
6973
+ "200": {
6974
+ "description": "Default Response",
6975
+ "content": {
6976
+ "application/json": {
6977
+ "schema": {
6978
+ "type": "array",
6979
+ "items": {
6980
+ "$ref": "#/components/schemas/ConnectionTypeInfo"
6981
+ }
6982
+ }
6983
+ }
6984
+ }
6985
+ }
6986
+ }
6987
+ }
6988
+ },
6888
6989
  "/client": {
6889
6990
  "get": {
6890
6991
  "operationId": "client/list",