@faable/auth-sdk 2.7.66 → 2.7.68

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.
@@ -441,7 +441,22 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
441
441
  mode?: "required" | "optional" | "off" | undefined;
442
442
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
443
443
  remember_device_days?: number | undefined;
444
- } | undefined;
444
+ } | undefined; /**
445
+ * `GET /user/{user_id}/factors` — operationId: `user/factors`
446
+ *
447
+ * List a user's second factors
448
+ *
449
+ * Management view of the security methods a user has enrolled. Carries no secret material — TOTP seeds and recovery-code hashes are redacted by the store, so this endpoint cannot be used to impersonate the user.
450
+ *
451
+ * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
452
+ * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
453
+ * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
454
+ * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
455
+ * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
456
+ * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
457
+ * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
458
+ * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
459
+ */
445
460
  recovery_channels?: {
446
461
  enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
447
462
  default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
@@ -502,7 +517,22 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
502
517
  mode?: "required" | "optional" | "off" | undefined;
503
518
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
504
519
  remember_device_days?: number | undefined;
505
- } | undefined;
520
+ } | undefined; /**
521
+ * `GET /user/{user_id}/factors` — operationId: `user/factors`
522
+ *
523
+ * List a user's second factors
524
+ *
525
+ * Management view of the security methods a user has enrolled. Carries no secret material — TOTP seeds and recovery-code hashes are redacted by the store, so this endpoint cannot be used to impersonate the user.
526
+ *
527
+ * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
528
+ * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
529
+ * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
530
+ * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
531
+ * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
532
+ * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
533
+ * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
534
+ * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
535
+ */
506
536
  recovery_channels?: {
507
537
  enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
508
538
  default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
@@ -566,7 +596,22 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
566
596
  mode?: "required" | "optional" | "off" | undefined;
567
597
  allowed_factors?: ("webauthn" | "totp")[] | undefined;
568
598
  remember_device_days?: number | undefined;
569
- } | undefined;
599
+ } | undefined; /**
600
+ * `GET /user/{user_id}/factors` — operationId: `user/factors`
601
+ *
602
+ * List a user's second factors
603
+ *
604
+ * Management view of the security methods a user has enrolled. Carries no secret material — TOTP seeds and recovery-code hashes are redacted by the store, so this endpoint cannot be used to impersonate the user.
605
+ *
606
+ * @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
607
+ * @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
608
+ * @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
609
+ * @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
610
+ * @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
611
+ * @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
612
+ * @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
613
+ * @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
614
+ */
570
615
  recovery_channels?: {
571
616
  enabled?: ("email" | "sms" | "whatsapp" | "factor")[] | undefined;
572
617
  default?: "email" | "sms" | "whatsapp" | "factor" | undefined;
@@ -3303,6 +3303,8 @@ export interface paths {
3303
3303
  "application/json": {
3304
3304
  client_id: string;
3305
3305
  redirect_to?: string;
3306
+ /** @description The login's key from `/authorize`. Only ties the ceremony to that login for tracing; not consumed, never rejects (`/passkey/login/verify` is the step that uses it). */
3307
+ state?: string;
3306
3308
  };
3307
3309
  };
3308
3310
  };
@@ -26680,6 +26682,8 @@ export interface operations {
26680
26682
  auth_params?: {
26681
26683
  [key: string]: string;
26682
26684
  };
26685
+ /** @description The login's key from `/authorize` — the hosted screen's `?state=`. Only ties the code this start issues to that login for tracing; it is not consumed and never rejects the request (`/passwordless/verify_code` is the step that uses it). */
26686
+ state?: string;
26683
26687
  };
26684
26688
  };
26685
26689
  };
package/dist/version.js CHANGED
@@ -9,13 +9,13 @@
9
9
  // login pages could not import the SDK at all. Same pattern as auth-js.
10
10
  //
11
11
  // The sentinels MUST stay byte-identical to the `from` values in `.releaserc`.
12
- export const version = "2.7.66";
12
+ export const version = "2.7.68";
13
13
  // Short git SHA of the released commit. The version dates a build; this names
14
14
  // the exact tree, so a canonical log line or an audit entry leads straight to
15
15
  // `git show <sha>`. Deliberately NOT hex: an unreleased build (dev, a local
16
16
  // link) cannot be mistaken for a real commit — auth only records values that
17
17
  // look like a SHA, and this one never will.
18
- export const commit = "b40ea33";
18
+ export const commit = "46acf9c";
19
19
  // What this SDK writes in `x-faable-client`. Exported for a consumer that
20
20
  // builds a strategy on its own (outside `FaableAuthApi`) and still wants the
21
21
  // token request attributed — a bare `authClientCredentials` stamps only what
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@faable/auth-sdk",
3
- "version": "2.7.66",
3
+ "version": "2.7.68",
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": "2.53.0",
6
+ "version": "2.55.0",
7
7
  "license": {
8
8
  "name": "private",
9
9
  "url": "https://faable.com/docs/platform/privacy-policy"
@@ -54922,6 +54922,10 @@
54922
54922
  "additionalProperties": {
54923
54923
  "type": "string"
54924
54924
  }
54925
+ },
54926
+ "state": {
54927
+ "type": "string",
54928
+ "description": "The login's key from `/authorize` — the hosted screen's `?state=`. Only ties the code this start issues to that login for tracing; it is not consumed and never rejects the request (`/passwordless/verify_code` is the step that uses it)."
54925
54929
  }
54926
54930
  }
54927
54931
  }
@@ -57073,6 +57077,10 @@
57073
57077
  },
57074
57078
  "redirect_to": {
57075
57079
  "type": "string"
57080
+ },
57081
+ "state": {
57082
+ "type": "string",
57083
+ "description": "The login's key from `/authorize`. Only ties the ceremony to that login for tracing; not consumed, never rejects (`/passkey/login/verify` is the step that uses it)."
57076
57084
  }
57077
57085
  }
57078
57086
  }