@faable/auth-sdk 2.7.104 → 2.7.106

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.
Files changed (6) hide show
  1. package/dist/FaableAuthApi.d.ts +30 -0
  2. package/dist/api/generated-client.d.ts +146 -5
  3. package/dist/api/types.d.ts +481 -10
  4. package/dist/version.js +2 -2
  5. package/package.json +1 -1
  6. package/spec/openapi.json +1385 -9
package/dist/FaableAuthApi.d.ts CHANGED
@@ -83,6 +83,12 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
83
83
  remember_me_days?: number | undefined;
84
84
  theme?: "system" | "light" | "dark" | undefined;
85
85
  } | undefined;
86
+ profile_fields?: {
87
+ key: string;
88
+ type: "string" | "enum";
89
+ options?: string[] | undefined;
90
+ max_length?: number | undefined;
91
+ }[] | null | undefined;
86
92
  login_flow?: string | null | undefined;
87
93
  mfa_policy?: {
88
94
  mode?: "required" | "optional" | "off" | undefined;
@@ -828,6 +834,12 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
828
834
  remember_me_days?: number | undefined;
829
835
  theme?: "system" | "light" | "dark" | undefined;
830
836
  } | undefined;
837
+ profile_fields?: {
838
+ key: string;
839
+ type: "string" | "enum";
840
+ options?: string[] | undefined;
841
+ max_length?: number | undefined;
842
+ }[] | null | undefined;
831
843
  mfa_policy?: {
832
844
  mode?: "required" | "optional" | "off" | undefined;
833
845
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
@@ -905,6 +917,12 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
905
917
  remember_me_days?: number | undefined;
906
918
  theme?: "system" | "light" | "dark" | undefined;
907
919
  } | undefined;
920
+ profile_fields?: {
921
+ key: string;
922
+ type: "string" | "enum";
923
+ options?: string[] | undefined;
924
+ max_length?: number | undefined;
925
+ }[] | null | undefined;
908
926
  mfa_policy?: {
909
927
  mode?: "required" | "optional" | "off" | undefined;
910
928
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
@@ -985,6 +1003,12 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
985
1003
  remember_me_days?: number | undefined;
986
1004
  theme?: "system" | "light" | "dark" | undefined;
987
1005
  } | undefined;
1006
+ profile_fields?: {
1007
+ key: string;
1008
+ type: "string" | "enum";
1009
+ options?: string[] | undefined;
1010
+ max_length?: number | undefined;
1011
+ }[] | null | undefined;
988
1012
  mfa_policy?: {
989
1013
  mode?: "required" | "optional" | "off" | undefined;
990
1014
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
@@ -1064,6 +1088,12 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
1064
1088
  remember_me_days?: number | undefined;
1065
1089
  theme?: "system" | "light" | "dark" | undefined;
1066
1090
  } | undefined;
1091
+ profile_fields?: {
1092
+ key: string;
1093
+ type: "string" | "enum";
1094
+ options?: string[] | undefined;
1095
+ max_length?: number | undefined;
1096
+ }[] | null | undefined;
1067
1097
  mfa_policy?: {
1068
1098
  mode?: "required" | "optional" | "off" | undefined;
1069
1099
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
package/dist/api/generated-client.d.ts CHANGED
@@ -82,6 +82,12 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
82
82
  remember_me_days?: number | undefined;
83
83
  theme?: "system" | "light" | "dark" | undefined;
84
84
  } | undefined;
85
+ profile_fields?: {
86
+ key: string;
87
+ type: "string" | "enum";
88
+ options?: string[] | undefined;
89
+ max_length?: number | undefined;
90
+ }[] | null | undefined;
85
91
  login_flow?: string | null | undefined;
86
92
  mfa_policy?: {
87
93
  mode?: "required" | "optional" | "off" | undefined;
@@ -162,6 +168,12 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
162
168
  remember_me_days?: number | undefined;
163
169
  theme?: "system" | "light" | "dark" | undefined;
164
170
  } | undefined;
171
+ profile_fields?: {
172
+ key: string;
173
+ type: "string" | "enum";
174
+ options?: string[] | undefined;
175
+ max_length?: number | undefined;
176
+ }[] | null | undefined;
165
177
  login_flow?: string | null | undefined;
166
178
  mfa_policy?: {
167
179
  mode?: "required" | "optional" | "off" | undefined;
@@ -262,6 +274,12 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
262
274
  remember_me_days?: number | undefined;
263
275
  theme?: "system" | "light" | "dark" | undefined;
264
276
  } | undefined;
277
+ profile_fields?: {
278
+ key: string;
279
+ type: "string" | "enum";
280
+ options?: string[] | undefined;
281
+ max_length?: number | undefined;
282
+ }[] | null | undefined;
265
283
  login_flow?: string | null | undefined;
266
284
  mfa_policy?: {
267
285
  mode?: "required" | "optional" | "off" | undefined;
@@ -345,6 +363,12 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
345
363
  remember_me_days?: number | undefined;
346
364
  theme?: "system" | "light" | "dark" | undefined;
347
365
  } | undefined;
366
+ profile_fields?: {
367
+ key: string;
368
+ type: "string" | "enum";
369
+ options?: string[] | undefined;
370
+ max_length?: number | undefined;
371
+ }[] | null | undefined;
348
372
  login_flow?: string | null | undefined;
349
373
  mfa_policy?: {
350
374
  mode?: "required" | "optional" | "off" | undefined;
@@ -476,6 +500,27 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
476
500
  remember_me_days?: number | undefined;
477
501
  theme?: "system" | "light" | "dark" | undefined;
478
502
  } | undefined;
503
+ profile_fields?: {
504
+ key: string;
505
+ type: "string" | "enum"; /**
506
+ * `POST /user/{user_id}/passkey-prompt/reset` — operationId: `user/resetPasskeyPrompt`
507
+ *
508
+ * Reset a user's passkey offer counter
509
+ *
510
+ * The post-login "create a passkey" offer stops after `login_methods.passkey_promotion_max_prompts` times and snoozes between them. This clears both, so the user is offered a passkey again on their next login — for "why does it keep asking" and "please ask me again" alike.
511
+ *
512
+ * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
513
+ * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
514
+ * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
515
+ * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
516
+ * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
517
+ * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
518
+ * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
519
+ * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
520
+ */
521
+ options?: string[] | undefined;
522
+ max_length?: number | undefined;
523
+ }[] | null | undefined;
479
524
  login_flow?: string | null | undefined;
480
525
  mfa_policy?: {
481
526
  mode?: "required" | "optional" | "off" | undefined;
@@ -540,6 +585,27 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
540
585
  remember_me_days?: number | undefined;
541
586
  theme?: "system" | "light" | "dark" | undefined;
542
587
  } | undefined;
588
+ profile_fields?: {
589
+ key: string;
590
+ type: "string" | "enum"; /**
591
+ * `POST /user/{user_id}/passkey-prompt/reset` — operationId: `user/resetPasskeyPrompt`
592
+ *
593
+ * Reset a user's passkey offer counter
594
+ *
595
+ * The post-login "create a passkey" offer stops after `login_methods.passkey_promotion_max_prompts` times and snoozes between them. This clears both, so the user is offered a passkey again on their next login — for "why does it keep asking" and "please ask me again" alike.
596
+ *
597
+ * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
598
+ * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
599
+ * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
600
+ * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
601
+ * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
602
+ * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
603
+ * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
604
+ * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
605
+ */
606
+ options?: string[] | undefined;
607
+ max_length?: number | undefined;
608
+ }[] | null | undefined;
543
609
  login_flow?: string | null | undefined;
544
610
  mfa_policy?: {
545
611
  mode?: "required" | "optional" | "off" | undefined;
@@ -607,6 +673,27 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
607
673
  remember_me_days?: number | undefined;
608
674
  theme?: "system" | "light" | "dark" | undefined;
609
675
  } | undefined;
676
+ profile_fields?: {
677
+ key: string;
678
+ type: "string" | "enum"; /**
679
+ * `POST /user/{user_id}/passkey-prompt/reset` — operationId: `user/resetPasskeyPrompt`
680
+ *
681
+ * Reset a user's passkey offer counter
682
+ *
683
+ * The post-login "create a passkey" offer stops after `login_methods.passkey_promotion_max_prompts` times and snoozes between them. This clears both, so the user is offered a passkey again on their next login — for "why does it keep asking" and "please ask me again" alike.
684
+ *
685
+ * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
686
+ * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
687
+ * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
688
+ * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
689
+ * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
690
+ * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
691
+ * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
692
+ * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
693
+ */
694
+ options?: string[] | undefined;
695
+ max_length?: number | undefined;
696
+ }[] | null | undefined;
610
697
  login_flow?: string | null | undefined;
611
698
  mfa_policy?: {
612
699
  mode?: "required" | "optional" | "off" | undefined;
@@ -866,6 +953,12 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
866
953
  remember_me_days?: number | undefined;
867
954
  theme?: "system" | "light" | "dark" | undefined;
868
955
  } | undefined;
956
+ profile_fields?: {
957
+ key: string;
958
+ type: "string" | "enum";
959
+ options?: string[] | undefined;
960
+ max_length?: number | undefined;
961
+ }[] | null | undefined;
869
962
  login_flow?: string | null | undefined;
870
963
  mfa_policy?: {
871
964
  mode?: "required" | "optional" | "off" | undefined;
@@ -1494,6 +1587,12 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
1494
1587
  remember_me_days?: number | undefined;
1495
1588
  theme?: "system" | "light" | "dark" | undefined;
1496
1589
  } | undefined;
1590
+ profile_fields?: {
1591
+ key: string;
1592
+ type: "string" | "enum";
1593
+ options?: string[] | undefined;
1594
+ max_length?: number | undefined;
1595
+ }[] | null | undefined;
1497
1596
  mfa_policy?: {
1498
1597
  mode?: "required" | "optional" | "off" | undefined;
1499
1598
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
@@ -1587,6 +1686,12 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
1587
1686
  remember_me_days?: number | undefined;
1588
1687
  theme?: "system" | "light" | "dark" | undefined;
1589
1688
  } | undefined;
1689
+ profile_fields?: {
1690
+ key: string;
1691
+ type: "string" | "enum";
1692
+ options?: string[] | undefined;
1693
+ max_length?: number | undefined;
1694
+ }[] | null | undefined;
1590
1695
  mfa_policy?: {
1591
1696
  mode?: "required" | "optional" | "off" | undefined;
1592
1697
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
@@ -1681,6 +1786,12 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
1681
1786
  remember_me_days?: number | undefined;
1682
1787
  theme?: "system" | "light" | "dark" | undefined;
1683
1788
  } | undefined;
1789
+ profile_fields?: {
1790
+ key: string;
1791
+ type: "string" | "enum";
1792
+ options?: string[] | undefined;
1793
+ max_length?: number | undefined;
1794
+ }[] | null | undefined;
1684
1795
  mfa_policy?: {
1685
1796
  mode?: "required" | "optional" | "off" | undefined;
1686
1797
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
@@ -1776,6 +1887,12 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
1776
1887
  remember_me_days?: number | undefined;
1777
1888
  theme?: "system" | "light" | "dark" | undefined;
1778
1889
  } | undefined;
1890
+ profile_fields?: {
1891
+ key: string;
1892
+ type: "string" | "enum";
1893
+ options?: string[] | undefined;
1894
+ max_length?: number | undefined;
1895
+ }[] | null | undefined;
1779
1896
  mfa_policy?: {
1780
1897
  mode?: "required" | "optional" | "off" | undefined;
1781
1898
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
@@ -1853,6 +1970,12 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
1853
1970
  remember_me_days?: number | undefined;
1854
1971
  theme?: "system" | "light" | "dark" | undefined;
1855
1972
  } | undefined;
1973
+ profile_fields?: {
1974
+ key: string;
1975
+ type: "string" | "enum";
1976
+ options?: string[] | undefined;
1977
+ max_length?: number | undefined;
1978
+ }[] | null | undefined;
1856
1979
  mfa_policy?: {
1857
1980
  mode?: "required" | "optional" | "off" | undefined;
1858
1981
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
@@ -1933,6 +2056,12 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
1933
2056
  remember_me_days?: number | undefined;
1934
2057
  theme?: "system" | "light" | "dark" | undefined;
1935
2058
  } | undefined;
2059
+ profile_fields?: {
2060
+ key: string;
2061
+ type: "string" | "enum";
2062
+ options?: string[] | undefined;
2063
+ max_length?: number | undefined;
2064
+ }[] | null | undefined;
1936
2065
  mfa_policy?: {
1937
2066
  mode?: "required" | "optional" | "off" | undefined;
1938
2067
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
@@ -2029,6 +2158,12 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
2029
2158
  remember_me_days?: number | undefined;
2030
2159
  theme?: "system" | "light" | "dark" | undefined;
2031
2160
  } | undefined;
2161
+ profile_fields?: {
2162
+ key: string;
2163
+ type: "string" | "enum";
2164
+ options?: string[] | undefined;
2165
+ max_length?: number | undefined;
2166
+ }[] | null | undefined;
2032
2167
  mfa_policy?: {
2033
2168
  mode?: "required" | "optional" | "off" | undefined;
2034
2169
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
@@ -2123,6 +2258,12 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
2123
2258
  remember_me_days?: number | undefined;
2124
2259
  theme?: "system" | "light" | "dark" | undefined;
2125
2260
  } | undefined;
2261
+ profile_fields?: {
2262
+ key: string;
2263
+ type: "string" | "enum";
2264
+ options?: string[] | undefined;
2265
+ max_length?: number | undefined;
2266
+ }[] | null | undefined;
2126
2267
  mfa_policy?: {
2127
2268
  mode?: "required" | "optional" | "off" | undefined;
2128
2269
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
@@ -5606,7 +5747,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
5606
5747
  last_seen_at: string;
5607
5748
  expires_at: string;
5608
5749
  revoked_at?: string | undefined;
5609
- revoked_reason?: "user" | "admin" | "logout" | undefined;
5750
+ revoked_reason?: "user" | "admin" | "logout" | "password_change" | undefined;
5610
5751
  account: string;
5611
5752
  metadata: {
5612
5753
  [key: string]: unknown;
@@ -5646,7 +5787,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
5646
5787
  last_seen_at: string;
5647
5788
  expires_at: string;
5648
5789
  revoked_at?: string | undefined;
5649
- revoked_reason?: "user" | "admin" | "logout" | undefined;
5790
+ revoked_reason?: "user" | "admin" | "logout" | "password_change" | undefined;
5650
5791
  account: string;
5651
5792
  metadata: {
5652
5793
  [key: string]: unknown;
@@ -5668,7 +5809,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
5668
5809
  last_seen_at: string;
5669
5810
  expires_at: string;
5670
5811
  revoked_at?: string | undefined;
5671
- revoked_reason?: "user" | "admin" | "logout" | undefined;
5812
+ revoked_reason?: "user" | "admin" | "logout" | "password_change" | undefined;
5672
5813
  account: string;
5673
5814
  metadata: {
5674
5815
  [key: string]: unknown;
@@ -5693,7 +5834,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
5693
5834
  last_seen_at: string;
5694
5835
  expires_at: string;
5695
5836
  revoked_at?: string | undefined;
5696
- revoked_reason?: "user" | "admin" | "logout" | undefined;
5837
+ revoked_reason?: "user" | "admin" | "logout" | "password_change" | undefined;
5697
5838
  account: string;
5698
5839
  metadata: {
5699
5840
  [key: string]: unknown;
@@ -5734,7 +5875,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
5734
5875
  last_seen_at: string;
5735
5876
  expires_at: string;
5736
5877
  revoked_at?: string | undefined;
5737
- revoked_reason?: "user" | "admin" | "logout" | undefined;
5878
+ revoked_reason?: "user" | "admin" | "logout" | "password_change" | undefined;
5738
5879
  account: string;
5739
5880
  metadata: {
5740
5881
  [key: string]: unknown;