@vibexp/api-client 0.95.0 → 0.96.0

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.
@@ -34,8 +34,8 @@ export declare const health: <ThrowOnError extends boolean = false>(options?: Op
34
34
  * URL to begin the authentication flow.
35
35
  *
36
36
  * The provider is chosen with the `provider` query parameter, whose value is
37
- * one of the deployment's enabled providers (e.g. `google`, `github`,
38
- * `oidc`). When exactly one provider is enabled the parameter may be omitted
37
+ * the slug of one of the deployment's enabled providers (e.g. `google`,
38
+ * `github`, `oidc`, or an admin-chosen slug such as `corp-sso`). When exactly one provider is enabled the parameter may be omitted
39
39
  * and that provider is used. When several are enabled the parameter is
40
40
  * required; an unknown or disabled value is rejected (no silent default).
41
41
  *
@@ -44,12 +44,13 @@ export declare const login: <ThrowOnError extends boolean = false>(options?: Opt
44
44
  /**
45
45
  * List enabled login providers
46
46
  *
47
- * Returns the login providers enabled in this deployment's configuration,
48
- * each with a canonical `name` (the value to pass as `?provider=` to
49
- * `GET /api/v1/auth/login`) and a human-readable `display_name` for the
50
- * login UI. The login screen uses this to render a provider picker instead
51
- * of hardcoding the provider list. The list is stable-sorted and may be
52
- * empty when no provider is configured.
47
+ * Returns the login providers enabled on this instance, each with its slug
48
+ * as `name` (the value to pass as `?provider=` to
49
+ * `GET /api/v1/auth/login`), a human-readable `display_name` for the login
50
+ * UI and its `type`. The login screen uses this to render a provider picker
51
+ * instead of hardcoding the provider list. The list is in the
52
+ * admin-defined sort order, reflects provider changes with no restart, and
53
+ * may be empty when no provider is enabled.
53
54
  *
54
55
  */
55
56
  export declare const listAuthProviders: <ThrowOnError extends boolean = false>(options?: Options<ListAuthProvidersData, ThrowOnError>) => RequestResult<ListAuthProvidersResponses, ListAuthProvidersErrors, ThrowOnError>;
@@ -30,8 +30,8 @@ export const health = (options) => (options?.client ?? client).get({
30
30
  * URL to begin the authentication flow.
31
31
  *
32
32
  * The provider is chosen with the `provider` query parameter, whose value is
33
- * one of the deployment's enabled providers (e.g. `google`, `github`,
34
- * `oidc`). When exactly one provider is enabled the parameter may be omitted
33
+ * the slug of one of the deployment's enabled providers (e.g. `google`,
34
+ * `github`, `oidc`, or an admin-chosen slug such as `corp-sso`). When exactly one provider is enabled the parameter may be omitted
35
35
  * and that provider is used. When several are enabled the parameter is
36
36
  * required; an unknown or disabled value is rejected (no silent default).
37
37
  *
@@ -44,12 +44,13 @@ export const login = (options) => (options?.client ?? client).get({
44
44
  /**
45
45
  * List enabled login providers
46
46
  *
47
- * Returns the login providers enabled in this deployment's configuration,
48
- * each with a canonical `name` (the value to pass as `?provider=` to
49
- * `GET /api/v1/auth/login`) and a human-readable `display_name` for the
50
- * login UI. The login screen uses this to render a provider picker instead
51
- * of hardcoding the provider list. The list is stable-sorted and may be
52
- * empty when no provider is configured.
47
+ * Returns the login providers enabled on this instance, each with its slug
48
+ * as `name` (the value to pass as `?provider=` to
49
+ * `GET /api/v1/auth/login`), a human-readable `display_name` for the login
50
+ * UI and its `type`. The login screen uses this to render a provider picker
51
+ * instead of hardcoding the provider list. The list is in the
52
+ * admin-defined sort order, reflects provider changes with no restart, and
53
+ * may be empty when no provider is enabled.
53
54
  *
54
55
  */
55
56
  export const listAuthProviders = (options) => (options?.client ?? client).get({
@@ -192,9 +192,9 @@ export type LogoutResponse = {
192
192
  */
193
193
  export type AuthProvider = {
194
194
  /**
195
- * Canonical provider name, also the value to pass as the `provider`
196
- * query parameter to GET /api/v1/auth/login (e.g. `google`, `github`,
197
- * `oidc`).
195
+ * Provider slug, also the value to pass as the `provider` query
196
+ * parameter to GET /api/v1/auth/login (e.g. `google`, `github`, `oidc`,
197
+ * or an admin-chosen slug such as `corp-sso`).
198
198
  *
199
199
  */
200
200
  name: string;
@@ -202,15 +202,21 @@ export type AuthProvider = {
202
202
  * Human-readable label for the provider button in the login UI
203
203
  */
204
204
  display_name: string;
205
+ /**
206
+ * The provider kind. Several `oidc` providers may be enabled side by
207
+ * side, each with its own slug.
208
+ *
209
+ */
210
+ type: 'google' | 'github' | 'oidc';
205
211
  };
206
212
  /**
207
213
  * Response body returned by GET /api/v1/auth/providers listing the login
208
- * providers enabled in this deployment's configuration.
214
+ * providers enabled on this instance.
209
215
  *
210
216
  */
211
217
  export type ProvidersResponse = {
212
218
  /**
213
- * Enabled login providers, stable-sorted by canonical name
219
+ * Enabled login providers, ordered by the admin-defined sort order
214
220
  */
215
221
  providers: Array<AuthProvider>;
216
222
  };
@@ -6963,9 +6969,9 @@ export type LoginData = {
6963
6969
  path?: never;
6964
6970
  query?: {
6965
6971
  /**
6966
- * Canonical name of the identity provider to use (e.g. `google`,
6967
- * `github`, `oidc`). Optional when a single provider is enabled;
6968
- * required when more than one is enabled.
6972
+ * Slug of the identity provider to use (the `name` returned by
6973
+ * GET /api/v1/auth/providers). Optional when a single provider is
6974
+ * enabled; required when more than one is enabled.
6969
6975
  *
6970
6976
  */
6971
6977
  provider?: string;
@@ -6984,7 +6990,9 @@ export type LoginErrors = {
6984
6990
  */
6985
6991
  500: ErrorResponse;
6986
6992
  /**
6987
- * No identity provider is configured (web login unavailable)
6993
+ * No identity provider is enabled (web login unavailable), or the
6994
+ * enabled providers could not be read
6995
+ *
6988
6996
  */
6989
6997
  503: ErrorResponse;
6990
6998
  };
@@ -7007,6 +7015,10 @@ export type ListAuthProvidersErrors = {
7007
7015
  * Internal server error
7008
7016
  */
7009
7017
  500: ErrorResponse;
7018
+ /**
7019
+ * The enabled providers could not be read
7020
+ */
7021
+ 503: ErrorResponse;
7010
7022
  };
7011
7023
  export type ListAuthProvidersError = ListAuthProvidersErrors[keyof ListAuthProvidersErrors];
7012
7024
  export type ListAuthProvidersResponses = {
@@ -7044,6 +7056,10 @@ export type AuthCallbackErrors = {
7044
7056
  * Identity provider authentication failed or session could not be created
7045
7057
  */
7046
7058
  500: ErrorResponse;
7059
+ /**
7060
+ * The enabled providers could not be read
7061
+ */
7062
+ 503: ErrorResponse;
7047
7063
  };
7048
7064
  export type AuthCallbackError = AuthCallbackErrors[keyof AuthCallbackErrors];
7049
7065
  export type LogoutData = {
package/dist/schema.d.ts CHANGED
@@ -58,8 +58,8 @@ export interface paths {
58
58
  * URL to begin the authentication flow.
59
59
  *
60
60
  * The provider is chosen with the `provider` query parameter, whose value is
61
- * one of the deployment's enabled providers (e.g. `google`, `github`,
62
- * `oidc`). When exactly one provider is enabled the parameter may be omitted
61
+ * the slug of one of the deployment's enabled providers (e.g. `google`,
62
+ * `github`, `oidc`, or an admin-chosen slug such as `corp-sso`). When exactly one provider is enabled the parameter may be omitted
63
63
  * and that provider is used. When several are enabled the parameter is
64
64
  * required; an unknown or disabled value is rejected (no silent default).
65
65
  */
@@ -81,12 +81,13 @@ export interface paths {
81
81
  };
82
82
  /**
83
83
  * List enabled login providers
84
- * @description Returns the login providers enabled in this deployment's configuration,
85
- * each with a canonical `name` (the value to pass as `?provider=` to
86
- * `GET /api/v1/auth/login`) and a human-readable `display_name` for the
87
- * login UI. The login screen uses this to render a provider picker instead
88
- * of hardcoding the provider list. The list is stable-sorted and may be
89
- * empty when no provider is configured.
84
+ * @description Returns the login providers enabled on this instance, each with its slug
85
+ * as `name` (the value to pass as `?provider=` to
86
+ * `GET /api/v1/auth/login`), a human-readable `display_name` for the login
87
+ * UI and its `type`. The login screen uses this to render a provider picker
88
+ * instead of hardcoding the provider list. The list is in the
89
+ * admin-defined sort order, reflects provider changes with no restart, and
90
+ * may be empty when no provider is enabled.
90
91
  */
91
92
  get: operations["listAuthProviders"];
92
93
  put?: never;
@@ -5854,9 +5855,9 @@ export interface components {
5854
5855
  /** @description One enabled login provider, with display metadata for the login UI */
5855
5856
  AuthProvider: {
5856
5857
  /**
5857
- * @description Canonical provider name, also the value to pass as the `provider`
5858
- * query parameter to GET /api/v1/auth/login (e.g. `google`, `github`,
5859
- * `oidc`).
5858
+ * @description Provider slug, also the value to pass as the `provider` query
5859
+ * parameter to GET /api/v1/auth/login (e.g. `google`, `github`, `oidc`,
5860
+ * or an admin-chosen slug such as `corp-sso`).
5860
5861
  * @example google
5861
5862
  */
5862
5863
  name: string;
@@ -5865,13 +5866,20 @@ export interface components {
5865
5866
  * @example Google
5866
5867
  */
5867
5868
  display_name: string;
5869
+ /**
5870
+ * @description The provider kind. Several `oidc` providers may be enabled side by
5871
+ * side, each with its own slug.
5872
+ * @example google
5873
+ * @enum {string}
5874
+ */
5875
+ type: "google" | "github" | "oidc";
5868
5876
  };
5869
5877
  /**
5870
5878
  * @description Response body returned by GET /api/v1/auth/providers listing the login
5871
- * providers enabled in this deployment's configuration.
5879
+ * providers enabled on this instance.
5872
5880
  */
5873
5881
  ProvidersResponse: {
5874
- /** @description Enabled login providers, stable-sorted by canonical name */
5882
+ /** @description Enabled login providers, ordered by the admin-defined sort order */
5875
5883
  providers: components["schemas"]["AuthProvider"][];
5876
5884
  };
5877
5885
  /** @description Request body for POST /api/v1/auth/dev/login (development environment only) */
@@ -13793,9 +13801,9 @@ export interface operations {
13793
13801
  parameters: {
13794
13802
  query?: {
13795
13803
  /**
13796
- * @description Canonical name of the identity provider to use (e.g. `google`,
13797
- * `github`, `oidc`). Optional when a single provider is enabled;
13798
- * required when more than one is enabled.
13804
+ * @description Slug of the identity provider to use (the `name` returned by
13805
+ * GET /api/v1/auth/providers). Optional when a single provider is
13806
+ * enabled; required when more than one is enabled.
13799
13807
  */
13800
13808
  provider?: string;
13801
13809
  };
@@ -13835,7 +13843,10 @@ export interface operations {
13835
13843
  "application/problem+json": components["schemas"]["ErrorResponse"];
13836
13844
  };
13837
13845
  };
13838
- /** @description No identity provider is configured (web login unavailable) */
13846
+ /**
13847
+ * @description No identity provider is enabled (web login unavailable), or the
13848
+ * enabled providers could not be read
13849
+ */
13839
13850
  503: {
13840
13851
  headers: {
13841
13852
  [name: string]: unknown;
@@ -13873,6 +13884,15 @@ export interface operations {
13873
13884
  "application/problem+json": components["schemas"]["ErrorResponse"];
13874
13885
  };
13875
13886
  };
13887
+ /** @description The enabled providers could not be read */
13888
+ 503: {
13889
+ headers: {
13890
+ [name: string]: unknown;
13891
+ };
13892
+ content: {
13893
+ "application/problem+json": components["schemas"]["ErrorResponse"];
13894
+ };
13895
+ };
13876
13896
  };
13877
13897
  };
13878
13898
  authCallback: {
@@ -13893,7 +13913,9 @@ export interface operations {
13893
13913
  * @description Redirects the browser to the frontend. On success, to the home page
13894
13914
  * (a session cookie is set). When sign-in is denied by the access
13895
13915
  * allowlist, to `/auth/callback?error=access_restricted` with no session
13896
- * cookie set.
13916
+ * cookie set. When the provider the flow started with was disabled or
13917
+ * removed before the callback, to
13918
+ * `/auth/callback?error=provider_unavailable`.
13897
13919
  */
13898
13920
  302: {
13899
13921
  headers: {
@@ -13935,6 +13957,15 @@ export interface operations {
13935
13957
  "application/problem+json": components["schemas"]["ErrorResponse"];
13936
13958
  };
13937
13959
  };
13960
+ /** @description The enabled providers could not be read */
13961
+ 503: {
13962
+ headers: {
13963
+ [name: string]: unknown;
13964
+ };
13965
+ content: {
13966
+ "application/problem+json": components["schemas"]["ErrorResponse"];
13967
+ };
13968
+ };
13938
13969
  };
13939
13970
  };
13940
13971
  logout: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vibexp/api-client",
3
- "version": "0.95.0",
3
+ "version": "0.96.0",
4
4
  "description": "Typed VibeXP API client generated from the OpenAPI spec (openapi-fetch main entrypoint, axios SDK at ./axios)",
5
5
  "license": "MIT",
6
6
  "repository": {