@zyphr-dev/node-sdk 0.1.10 → 0.1.14

package/README.md

@@ -377,21 +377,52 @@ await zyphr.devices.deleteUserDevices('user_123');
 
 ### Authentication — `zyphr.auth.*`
 
-Full authentication API with login, registration, MFA, magic links, OAuth, and more.
+Full Auth-as-a-Service API for end-user authentication: registration, login, MFA, magic links, OAuth, and more.
+
+> **Important:** Auth endpoints require application credentials, not just an API key. Create an application in the Zyphr dashboard first, then pass the credentials when constructing the client:
+
+```ts
+const zyphr = new Zyphr({
+  apiKey: process.env.ZYPHR_API_KEY!,
+  applicationKey: process.env.ZYPHR_APP_PUBLIC_KEY!,   // za_pub_*
+  applicationSecret: process.env.ZYPHR_APP_SECRET_KEY!, // za_sec_*
+});
+```
+
+> **Common mistake:** `POST /v1/auth/register` creates a **platform account** (for the Zyphr dashboard). To register **end users** in your application, use `POST /v1/auth/users/register` via `zyphr.auth.registration.registerEndUser()`.
 
 ```ts
+// Register an end user
+const result = await zyphr.auth.registration.registerEndUser({
+  registerRequest: {
+    email: 'new@example.com',
+    password: 'SecureP@ss123',
+    name: 'New User',
+  },
+});
+// result.data.user — the new user
+// result.data.tokens — { access_token, refresh_token, expires_in }
+
 // Login
 const session = await zyphr.auth.login.loginEndUser({
-  email: 'user@example.com',
-  password: 'secure_password',
+  loginRequest: {
+    email: 'user@example.com',
+    password: 'SecureP@ss123',
+  },
 });
 
-// Registration
-await zyphr.auth.registration.registerUser({
-  email: 'new@example.com',
-  password: 'secure_password',
-  name: 'New User',
+// User profile (requires end-user access token)
+// Use zyphr.asEndUser(token) to authenticate as the end user
+const login = await zyphr.auth.login.loginEndUser({
+  loginRequest: { email: 'user@example.com', password: 'SecureP@ss123' },
 });
+const token = login.data.tokens.access_token;
+
+const profile = await zyphr.auth.profile.getEndUser(zyphr.asEndUser(token));
+await zyphr.auth.profile.updateEndUser(
+  { updateEndUserRequest: { name: 'Updated Name' } },
+  zyphr.asEndUser(token),
+);
 
 // Email verification
 await zyphr.auth.emailVerification.sendVerification('user@example.com');
@@ -405,14 +436,12 @@ await zyphr.auth.magicLinks.sendMagicLink('user@example.com');
 // MFA
 const mfaStatus = await zyphr.auth.mfa.getMfaStatus();
 await zyphr.auth.mfa.enrollMfa({ method: 'totp' });
-
-// User profile
-const profile = await zyphr.auth.profile.getProfile();
-await zyphr.auth.profile.updateProfile({ name: 'Updated Name' });
 ```
 
 **Available auth modules:** `login`, `registration`, `sessions`, `emailVerification`, `passwordReset`, `magicLinks`, `mfa`, `oauth`, `phone`, `webauthn`, `profile`.
 
+See the [Auth-as-a-Service guide](https://zyphr.dev/docs/guides/auth-as-a-service) for the full setup walkthrough.
+
 ### WaaS — `zyphr.waas.*`
 
 Webhooks-as-a-Service: multi-tenant webhook delivery infrastructure for your customers.

package/dist/index.cjs

@@ -19678,7 +19678,11 @@ var Zyphr = class {
   constructor(options) {
     const config = new Configuration({
       basePath: options.baseUrl,
-      apiKey: () => options.apiKey,
+      apiKey: (name) => {
+        if (name === "X-Application-Key" && options.applicationKey) return options.applicationKey;
+        if (name === "X-Application-Secret" && options.applicationSecret) return options.applicationSecret;
+        return options.apiKey;
+      },
       middleware: [errorMiddleware]
     });
     this.emails = new EmailsApi(config);
@@ -19712,6 +19716,26 @@ var Zyphr = class {
       webauthn: new AuthWebAuthnApi(config)
     };
   }
+  /**
+   * Create request overrides that authenticate as an end user.
+   * Use this when calling profile, session, or MFA endpoints that
+   * require the end user's access token instead of the API key.
+   *
+   * @example
+   * ```ts
+   * const login = await zyphr.auth.login.loginEndUser({ ... });
+   * const token = login.data.tokens.access_token;
+   *
+   * const profile = await zyphr.auth.profile.getEndUser(
+   *   zyphr.asEndUser(token)
+   * );
+   * ```
+   */
+  asEndUser(accessToken) {
+    return {
+      headers: { Authorization: `Bearer ${accessToken}` }
+    };
+  }
 };
 
 // src/index.ts