@nulvless/nulvless-js 0.1.4 → 0.1.6

package/README.md

@@ -18,7 +18,7 @@ npm install @nulvless/nulvless-js
 
 ### Browser
 
-Create the client with your project URL and publishable key. The session is stored and renewed for you.
+Create the client with your project URL and publishable key. The session is stored and renewed for you. The project URL is `https://<project>.nulvless.co`, or your own [custom domain](https://nulvless.com/docs/guides/custom-domains) (e.g. `https://api.example.com`) on plans that include it.
 
 ```ts
 import { createClient } from '@nulvless/nulvless-js'

package/dist/index.cjs

@@ -317,6 +317,10 @@ var FactorsClient = class extends AuthSubClient {
    * the factor on the user's device.
    *
    * For TOTP: use `secret` for manual entry or `url` to generate a QR code.
+   * For SMS: pass `phone` to send the codes to a number other than the user's.
+   *
+   * A user holds up to 10 authenticator apps and SMS factors combined, and one
+   * email factor and one set of recovery codes.
    *
    * After the user configures their device, call `enable` with the `token` and
    * the first OTP code to activate the factor.
@@ -332,8 +336,9 @@ var FactorsClient = class extends AuthSubClient {
   async enroll(params, options) {
     const auth = await this.bearer(options);
     if (!auth.ok) return { data: null, error: auth.error };
-    const { nonce, type, name } = params;
-    return this.http.post(route`/factors/${type}`, name ? { name } : {}, {
+    const { nonce, type, name, phone } = params;
+    const body = { ...name ? { name } : {}, ...phone ? { phone } : {} };
+    return this.http.post(route`/factors/${type}`, body, {
       ...options,
       nonce,
       headers: { ...options?.headers, ...auth.headers }
@@ -379,7 +384,6 @@ var FactorsClient = class extends AuthSubClient {
 
 // src/auth/users/index.ts
 var UsersClient = class extends AuthSubClient {
-  // ─── Profile ────────────────────────────────────────────────────────────────
   /**
    * Returns the authenticated user's full profile.
    */
@@ -404,7 +408,6 @@ var UsersClient = class extends AuthSubClient {
       headers: { ...options?.headers, ...auth.headers }
     });
   }
-  // ─── Identities ─────────────────────────────────────────────────────────────
   /**
    * Lists all identities (email, phone, OAuth) linked to the authenticated user.
    *
@@ -495,7 +498,6 @@ var UsersClient = class extends AuthSubClient {
       headers: { ...options?.headers, ...auth.headers }
     });
   }
-  // ─── Credential updates ──────────────────────────────────────────────────────
   /**
    * Sends an OTP to the new email address to initiate an email change.
    *
@@ -695,14 +697,19 @@ var ChallengesClient = class extends AuthSubClient {
    * Requires an authenticated session. Prompt the user for the code, then call
    * `verify({ token, code })`.
    *
+   * A `totp` challenge accepts a code from any of the user's authenticator
+   * apps. For `sms_otp`, pass `factor_id` to pick which phone receives it.
+   *
    * @example
-   * const { data } = await nulvless.auth.challenges.create('totp')
+   * const { data } = await nulvless.auth.challenges.create({ type: 'totp' })
+   * const { data: sms } = await nulvless.auth.challenges.create({ type: 'sms_otp', factor_id })
    */
-  async create(targetType, options) {
+  async create(params, options) {
     const auth = await this.bearer(options);
     if (!auth.ok) return { data: null, error: auth.error };
-    return this.http.post(route`/challenges/${targetType}`, void 0, {
+    return this.http.post(route`/challenges/${params.type}`, void 0, {
       ...options,
+      ...params.factor_id ? { query: { factor_id: params.factor_id } } : {},
       headers: { ...options?.headers, ...auth.headers }
     });
   }
@@ -722,7 +729,7 @@ var ChallengesClient = class extends AuthSubClient {
     return this.http.patch(
       route`/challenges/${params.type}`,
       { token: params.token },
-      options
+      params.factor_id ? { ...options, query: { factor_id: params.factor_id } } : options
     );
   }
   /**
@@ -922,7 +929,6 @@ var OAuthClient = class extends AuthSubClient {
     super(http, getToken);
     this.grants = new OAuthGrantsClient(http, getToken);
   }
-  // ─── Authorization redirect (platform key) ──────────────────────────────────
   /**
    * Builds the OAuth authorization URL and, in the browser, redirects the user
    * agent to it. On the server the URL is returned for manual handling.
@@ -967,7 +973,6 @@ var OAuthClient = class extends AuthSubClient {
     }
     return { data: { url: url.toString() }, error: null };
   }
-  // ─── Token endpoint (public) ────────────────────────────────────────────────
   /**
    * Exchanges an authorization code for tokens
    * (`POST /oauth/token`, `grant_type=authorization_code`).
@@ -997,7 +1002,6 @@ var OAuthClient = class extends AuthSubClient {
       { ...options, skipApiKey: true }
     );
   }
-  // ─── Dynamic registration (platform key) ────────────────────────────────────
   /**
    * Dynamically registers a new OAuth app (RFC 7591, `POST /oauth/register`).
    *
@@ -1007,7 +1011,6 @@ var OAuthClient = class extends AuthSubClient {
   register(params, options) {
     return this.http.post("/oauth/register", params, { ...options, skipApiKey: true });
   }
-  // ─── Consent flow (authenticated user) ──────────────────────────────────────
   /**
    * Loads a pending authorization for the consent screen
    * (`GET /oauth/authorizations/:id`).
@@ -1042,7 +1045,6 @@ var OAuthClient = class extends AuthSubClient {
       headers: { ...options?.headers, ...auth.headers }
     });
   }
-  // ─── UserInfo (authenticated user) ──────────────────────────────────────────
   /**
    * Returns OIDC UserInfo claims for the access token (`GET /oauth/userinfo`).
    *
@@ -1058,7 +1060,6 @@ var OAuthClient = class extends AuthSubClient {
       headers: { ...options?.headers, ...auth.headers }
     });
   }
-  // ─── Public OIDC metadata (no auth) ─────────────────────────────────────────
   /**
    * Returns the OpenID Connect discovery document
    * (`GET /.well-known/openid-configuration`). Public — no auth required.
@@ -1283,12 +1284,6 @@ var AdminClient = class {
   roles;
   grants;
   oauthClients;
-  /**
-   * Returns basic platform information (id, name, slug).
-   */
-  getPlatform(options) {
-    return this.http.get("/admin/platform", options);
-  }
 };
 
 // src/session/stored.ts
@@ -1463,14 +1458,12 @@ var AuthClient = class {
   async getAccessToken() {
     return this.session?.getValidToken() ?? null;
   }
-  // ─── Helpers ──────────────────────────────────────────────────────────────
   async persistSession(result) {
     if (!result.error && result.data.access_token && this.session) {
       await this.session.save(result.data);
     }
     return result;
   }
-  // ─── Sign-up / Sign-in ─────────────────────────────────────────────────────
   /**
    * Creates a new user account.
    *
@@ -1631,7 +1624,6 @@ var AuthClient = class {
       headers: { ...options?.headers, ...auth.headers }
     });
   }
-  // ─── Challenge ─────────────────────────────────────────────────────────────
   /**
    * Looks up whether an identifier exists and which sign-in method applies.
    *
@@ -1658,7 +1650,6 @@ var AuthClient = class {
   async verifyChallenge(params, options) {
     return this.challenges.verify(params, options);
   }
-  // ─── Account lifecycle ─────────────────────────────────────────────────────
   /**
    * Activates an account via the confirmation link sent to the user's email/phone.
    */
@@ -1692,7 +1683,6 @@ var AuthClient = class {
   resetPassword(params, options) {
     return this.http.post("/recover/reset-password", params, options);
   }
-  // ─── Session ───────────────────────────────────────────────────────────────
   /**
    * Validates the current session and optionally checks a grant.
    *
@@ -1811,7 +1801,6 @@ var AuthBrowserClient = class extends AuthClient {
   on(event, handler) {
     return this.emitter.on(event, handler);
   }
-  // ─── Session persistence override ─────────────────────────────────────────
   async persistSession(result) {
     const out = await super.persistSession(result);
     if (!out.error) {
@@ -1826,7 +1815,6 @@ var AuthBrowserClient = class extends AuthClient {
     }
     return out;
   }
-  // ─── Active session helpers ────────────────────────────────────────────────
   /**
    * Returns the session currently stored in storage, or `null` if there is none.
    *
@@ -1858,7 +1846,6 @@ var AuthBrowserClient = class extends AuthClient {
       await this.session?.save(data);
     }
   }
-  // ─── Multi-account ─────────────────────────────────────────────────────────
   /**
    * Adds an account to the accounts store without switching the active session.
    *
@@ -1937,7 +1924,6 @@ var AuthBrowserClient = class extends AuthClient {
     }
     await this.session?.clear();
   }
-  // ─── signOut override ──────────────────────────────────────────────────────
   async signOut(scope, options) {
     const stored = await this.session?.get();
     const userId = stored ? stored.user?.id ?? extractUserId({ access_token: stored.access_token }) : null;
@@ -2459,7 +2445,7 @@ var NulvlessServerClient = class {
   constructor(baseUrl, privateKey, options) {
     const base = baseUrl.replace(/\/+$/, "");
     this.auth = new AuthServerClient(new HttpClient({ baseUrl: `${base}/auth`, apiKey: privateKey, ...options }));
-    this.comms = new CommsClient(new HttpClient({ baseUrl: `${base}/notifications`, apiKey: privateKey, ...options }));
+    this.comms = new CommsClient(new HttpClient({ baseUrl: `${base}/comms`, apiKey: privateKey, ...options }));
   }
 };