@tempoxyz/auth 0.0.0-pr-67.sha-53ccafe → 0.0.0-pr-73.sha-accbf0a

package/dist/Actions.d.ts

@@ -12,6 +12,7 @@ import type { Tokens } from './Tokens.ts';
 export * as device from './actions/device.ts';
 export * as email from './actions/email.ts';
 export * as oauth from './actions/oauth.ts';
+export * as passkey from './actions/passkey.ts';
 export * as provider from './actions/provider.ts';
 export * as redirect from './actions/redirect.ts';
 export * as tempoAccount from './actions/tempoAccount.ts';
@@ -34,6 +35,12 @@ export declare namespace authorize {
          * defaults to the user's first. Defaults to a new key.
          */
         accessKey?: Account.Account | undefined;
+        /**
+         * A message the owner's signature binds, such as a sign-in challenge the app's backend issued.
+         * Tempo Auth binds its EIP-191 hash as the key authorization's `witness`. Only an app with the
+         * `tempo-auth:sign` scope may send one.
+         */
+        challenge?: string | undefined;
         /** What the key may do. It must fit the headless ceiling, which fills what it leaves out. */
         permissions?: Permissions<chainId> | undefined;
     };

package/dist/Actions.js

@@ -4,6 +4,7 @@ import { request } from './internal/request.js';
 export * as device from './actions/device.js';
 export * as email from './actions/email.js';
 export * as oauth from './actions/oauth.js';
+export * as passkey from './actions/passkey.js';
 export * as provider from './actions/provider.js';
 export * as redirect from './actions/redirect.js';
 export * as tempoAccount from './actions/tempoAccount.js';
@@ -29,6 +30,7 @@ export async function authorize(auth, options = {}) {
     const response = await Api.post(auth, '/v1/authorize', {
         json: request(auth, {
             accessKey: key.accessKey,
+            challenge: options.challenge,
             permissions: options.permissions,
         }),
     });

package/dist/Auth.d.ts

@@ -86,7 +86,7 @@ export declare namespace RequestError {
         uri?: string | undefined;
     };
     /** Each refusal's stable name. `docs/errors.md` explains each one. */
-    type Reason = 'already_decided' | 'approval_pending' | 'body_too_large' | 'cross_site_request' | 'device_code_expired' | 'duplicate_limit' | 'empty_limits' | 'empty_scopes' | 'expiry_exceeds_maximum' | 'expiry_passed' | 'foreign_account' | 'foreign_origin' | 'invalid_chain' | 'invalid_code' | 'invalid_expiry' | 'invalid_field' | 'invalid_origin' | 'invalid_period' | 'invalid_public_key' | 'limit_exceeds_maximum' | 'malformed_body' | 'missing_code_challenge' | 'missing_key' | 'missing_recipients' | 'polling_too_fast' | 'rate_limited' | 'rejected' | 'request_denied' | 'scope_without_limit' | 'session_required' | 'unexpected' | 'unknown_code' | 'unknown_endpoint' | 'unsupported_call' | 'unsupported_step' | 'unsupported_token' | 'upstream_unavailable' | 'webauthn_rejected';
+    type Reason = 'already_decided' | 'approval_pending' | 'body_too_large' | 'challenge_not_permitted' | 'cross_site_request' | 'device_code_expired' | 'duplicate_limit' | 'empty_limits' | 'empty_scopes' | 'expiry_exceeds_maximum' | 'expiry_passed' | 'foreign_account' | 'foreign_origin' | 'invalid_chain' | 'invalid_code' | 'invalid_expiry' | 'invalid_field' | 'invalid_origin' | 'invalid_period' | 'invalid_public_key' | 'limit_exceeds_maximum' | 'malformed_body' | 'missing_code_challenge' | 'missing_key' | 'missing_recipients' | 'polling_too_fast' | 'rate_limited' | 'rejected' | 'request_denied' | 'scope_without_limit' | 'session_required' | 'unexpected' | 'unknown_code' | 'unknown_endpoint' | 'unsupported_call' | 'unsupported_step' | 'unsupported_token' | 'upstream_unavailable' | 'webauthn_rejected' | 'webauthn_required';
 }
 /** A client's {@link Account} read before a sign-in set it, or after sign-out emptied it. */
 export declare class SignedOutError extends Error {

package/dist/Decorator.d.ts

@@ -82,7 +82,10 @@ export declare namespace tempoAuth {
             email: {
                 /** `Actions.email.sendCode`. */
                 sendCode: (options: Actions.email.sendCode.Options) => Promise<void>;
-                /** `Actions.email.signIn`, which sets the client's account unless it returns a step. */
+                /**
+                 * `Actions.email.signIn`, which sets the client's account unless it returns a step. A step
+                 * that another sign-in or a sign-out overtook throws {@link SupersededError}.
+                 */
                 signIn: <const id extends number = chainId>(options: Actions.email.signIn.Options<id>) => Promise<Actions.email.signIn.ReturnType<id>>;
             };
             /** The instance the members call `Actions` with. */
@@ -95,6 +98,13 @@ export declare namespace tempoAuth {
                 /** `Actions.oauth.userInfo`. */
                 userInfo: (options: Actions.oauth.userInfo.Options) => Promise<User>;
             };
+            passkey: {
+                /**
+                 * `Actions.passkey.signIn`, which sets the client's account unless it returns a step. A step
+                 * that another sign-in or a sign-out overtook throws {@link SupersededError}.
+                 */
+                signIn: <const id extends number = chainId>(options?: Actions.passkey.signIn.Options<id>) => Promise<Actions.passkey.signIn.ReturnType<id>>;
+            };
             provider: {
                 /** `Actions.provider.list`. */
                 list: () => Promise<Actions.provider.list.ReturnType>;

package/dist/Decorator.js

@@ -54,42 +54,58 @@ export function tempoAuth(options) {
         // sign-in or sign-out completed after it began, so a stale result never replaces a newer one,
         // and a sign-in still pending at sign-out never signs the client back in.
         let version = 0;
+        // The version the latest sign-out produced, while no change has followed it.
+        let signedOut;
         /**
-         * Begins an operation that changes the client's account, and returns the function that applies
-         * its result: the account to sign with, or `undefined` to stop signing. Applying an account that
-         * a newer change overtook throws {@link SupersededError}, so the caller never holds an
-         * authorization the client does not sign with.
+         * Begins an operation that changes the client's account. `apply` applies its result: the
+         * account to sign with, or `undefined` to stop signing. `check` accepts a result that changes
+         * no account, such as a step. Applying an account, or checking a step, that a newer change
+         * overtook throws {@link SupersededError}, so the caller never holds a result the client's
+         * newer state contradicts.
          */
         const begin = () => {
             const started = version;
-            return (account) => {
-                if (version !== started) {
-                    if (account)
-                        throw new SupersededError();
-                    return;
-                }
-                state.account = account;
-                version++;
+            // A sign-in that finishes after sign-out may have set a new server session, so it ends that
+            // session again, unless a newer change already followed the sign-out.
+            const superseded = async () => {
+                if (signedOut === version)
+                    await Actions.signOut(auth);
+                return new SupersededError();
+            };
+            return {
+                async apply(account) {
+                    if (version !== started) {
+                        if (account)
+                            throw await superseded();
+                        return;
+                    }
+                    state.account = account;
+                    version++;
+                },
+                async check() {
+                    if (version !== started)
+                        throw await superseded();
+                },
             };
         };
         return {
             auth: {
                 async authorize(options = {}) {
-                    const apply = begin();
+                    const change = begin();
                     const authorization = await Actions.authorize(auth, options);
                     // Without a session, the client stops signing as the user it last authorized.
-                    apply(authorization?.account);
+                    await change.apply(authorization?.account);
                     return authorization;
                 },
                 device: {
                     async authorize(options = {}) {
-                        const apply = begin();
+                        const change = begin();
                         const device = await Actions.device.authorize(auth, options);
                         return {
                             ...device,
                             async wait() {
                                 const authorization = await device.wait();
-                                apply(authorization.account);
+                                await change.apply(authorization.account);
                                 return authorization;
                             },
                         };
@@ -98,10 +114,12 @@ export function tempoAuth(options) {
                 email: {
                     sendCode: (options) => Actions.email.sendCode(auth, options),
                     async signIn(options) {
-                        const apply = begin();
+                        const change = begin();
                         const result = await Actions.email.signIn(auth, options);
-                        if (!('step' in result))
-                            apply(result.account);
+                        if ('step' in result)
+                            await change.check();
+                        else
+                            await change.apply(result.account);
                         return result;
                     },
                 },
@@ -111,24 +129,35 @@ export function tempoAuth(options) {
                     jwks: () => Actions.oauth.jwks(auth),
                     userInfo: (options) => Actions.oauth.userInfo(auth, options),
                 },
+                passkey: {
+                    async signIn(options = {}) {
+                        const change = begin();
+                        const result = await Actions.passkey.signIn(auth, options);
+                        if ('step' in result)
+                            await change.check();
+                        else
+                            await change.apply(result.account);
+                        return result;
+                    },
+                },
                 provider: {
                     list: () => Actions.provider.list(auth),
                     signIn: (options) => Actions.provider.signIn(auth, options),
                 },
                 redirect: {
                     async complete(options = {}) {
-                        const apply = begin();
+                        const change = begin();
                         const authorization = await Actions.redirect.complete(auth, options);
                         // `undefined` means the page is not a callback, which says nothing about the session.
                         if (authorization)
-                            apply(authorization.account);
+                            await change.apply(authorization.account);
                         return authorization;
                     },
                     createUrl: (options = {}) => Actions.redirect.createUrl(auth, options),
                     async handleCallback(options) {
-                        const apply = begin();
+                        const change = begin();
                         const authorization = await Actions.redirect.handleCallback(auth, options);
-                        apply(authorization.account);
+                        await change.apply(authorization.account);
                         return authorization;
                     },
                     start: (options = {}) => Actions.redirect.start(auth, options),
@@ -138,7 +167,8 @@ export function tempoAuth(options) {
                     // A sign-in stored before `Key.chainId` existed gains it here.
                     const key = Key.from(authorization.key);
                     const account = Key.toAccount(key, options);
-                    begin()(account);
+                    state.account = account;
+                    version++;
                     return { ...authorization, account, key };
                 },
                 async signOut() {
@@ -146,6 +176,7 @@ export function tempoAuth(options) {
                     // pending is discarded, since the user asked to leave.
                     state.account = undefined;
                     version++;
+                    signedOut = version;
                     await Actions.signOut(auth);
                 },
                 tempoAccount: {

package/dist/TempoAccount.d.ts

@@ -6,13 +6,19 @@
 export type TempoAccount = {
     /** The account's address, the same on every Tempo chain. */
     address: `0x${string}`;
+    /**
+     * Who holds the account's owner key: a Privy wallet, which Tempo Auth signs with (`privy`), or a
+     * passkey, which signs only on a Tempo Auth page (`webAuthn`). Treat another value as an owner
+     * that may refuse a key authorization.
+     */
+    owner: 'privy' | 'webAuthn' | (string & {});
 };
 /**
  * Instantiates a {@link TempoAccount}.
  *
  * @example
  * ```ts
- * const tempoAccount = TempoAccount.from({ address: '0x…' })
+ * const tempoAccount = TempoAccount.from({ address: '0x…', owner: 'privy' })
  * ```
  */
 export declare function from(value: TempoAccount): TempoAccount;

package/dist/TempoAccount.js

@@ -3,7 +3,7 @@
  *
  * @example
  * ```ts
- * const tempoAccount = TempoAccount.from({ address: '0x…' })
+ * const tempoAccount = TempoAccount.from({ address: '0x…', owner: 'privy' })
  * ```
  */
 export function from(value) {

package/dist/actions/device.d.ts

@@ -21,6 +21,12 @@ export declare namespace authorize {
          * defaults to the user's first. Defaults to a new key.
          */
         accessKey?: Account.Account | undefined;
+        /**
+         * A message the owner's signature binds, such as a sign-in challenge the app's backend issued.
+         * Tempo Auth binds its EIP-191 hash as the key authorization's `witness`. Only an app with the
+         * `tempo-auth:sign` scope may send one.
+         */
+        challenge?: string | undefined;
         /**
          * The name the approval page shows. Defaults to the machine's hostname in Node, Bun, and Deno,
          * and to `Unknown device` elsewhere.

package/dist/actions/device.js

@@ -17,6 +17,9 @@ export async function authorize(auth, options = {}) {
     const key = await AccessKey.resolve(options.accessKey);
     const code = await Api.json(await Api.post(auth, '/v1/device/authorize', {
         json: {
+            ...(options.challenge === undefined
+                ? {}
+                : { challenge: options.challenge }),
             device: options.device ?? hostname(),
             key_authorization: request(auth, {
                 accessKey: key.accessKey,

package/dist/actions/email.d.ts

@@ -40,10 +40,21 @@ export declare namespace signIn {
          * defaults to the user's first. Defaults to a new key.
          */
         accessKey?: Account.Account | undefined;
+        /**
+         * A message the owner's signature binds, such as a sign-in challenge the app's backend issued.
+         * Tempo Auth binds its EIP-191 hash as the key authorization's `witness`. Only an app with the
+         * `tempo-auth:sign` scope may send one.
+         */
+        challenge?: string | undefined;
         /** The 6-digit code the user was emailed. */
         code: string;
         /** The address the code was sent to. */
         email: string;
+        /**
+         * The `link` from `Actions.passkey.signIn`'s email step, which links that wallet.tempo passkey
+         * to the user.
+         */
+        link?: string | undefined;
         /** What the key may do. It must fit the headless ceiling, which fills what it leaves out. */
         permissions?: Permissions<chainId> | undefined;
     };

package/dist/actions/email.js

@@ -23,13 +23,18 @@ export async function sendCode(auth, options) {
  * ```
  */
 export async function signIn(auth, options) {
-    const { code, email, permissions } = options;
+    const { challenge, code, email, link, permissions } = options;
     const key = await AccessKey.resolve(options.accessKey);
     const body = await Api.json(await Api.post(auth, '/v1/auth/code/verify', {
         json: {
-            authorize: request(auth, { accessKey: key.accessKey, permissions }),
+            authorize: request(auth, {
+                accessKey: key.accessKey,
+                challenge,
+                permissions,
+            }),
             code,
             email,
+            ...(link ? { link } : {}),
         },
     }));
     if ('step' in body)

package/dist/actions/passkey.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Signs the user in with a passkey from the app's own sign-in form. The browser offers every passkey
+ * it holds for Tempo's domain, so the app needs no email first.
+ * @module
+ */
+import { Authentication } from 'ox/webauthn';
+import type { Account } from 'viem/tempo';
+import type { Auth } from '../Auth.ts';
+import type { Authorization } from '../Authorization.ts';
+import type { Permissions } from '../Permissions.ts';
+/**
+ * Signs the user in with a passkey, and authorizes the app in the same call. Returns the email step
+ * for a wallet.tempo passkey whose account has no email: the app signs the user in with
+ * `Actions.email.signIn`, passing the step's `link`, which links the passkey, and the same
+ * `accessKey`, `challenge`, and `permissions`, which this call does not authorize. Throws a `RequestError` with reason
+ * `webauthn_required` when a passkey owns the Tempo Account the key acts for, since a passkey signs a
+ * key authorization only on Tempo Auth's pages. `Actions.redirect.start` authorizes it there, where
+ * the user is already signed in.
+ *
+ * @example
+ * ```ts
+ * const result = await Actions.passkey.signIn(auth)
+ * if ('step' in result) showEmailForm()
+ * ```
+ */
+export declare function signIn<const chainId extends number = number>(auth: Auth, options?: signIn.Options<chainId>): Promise<signIn.ReturnType<chainId>>;
+export declare namespace signIn {
+    type Options<chainId extends number = number> = {
+        /**
+         * The key to authorize, as a Viem account. Its `access` names the Tempo Account, which
+         * defaults to the user's first. Defaults to a new key.
+         */
+        accessKey?: Account.Account | undefined;
+        /**
+         * A message the owner's signature binds, such as a sign-in challenge the app's backend issued.
+         * Tempo Auth binds its EIP-191 hash as the key authorization's `witness`. Only an app with the
+         * `tempo-auth:sign` scope may send one.
+         */
+        challenge?: string | undefined;
+        /**
+         * Runs the WebAuthn ceremony in place of `navigator.credentials.get`, such as a native passkey
+         * module. Its assertion must report a web origin on the relying party's domain that the app
+         * registered, so an Android app's facet origin is refused.
+         */
+        getFn?: Authentication.sign.Options['getFn'] | undefined;
+        /** What the key may do. It must fit the headless ceiling, which fills what it leaves out. */
+        permissions?: Permissions<chainId> | undefined;
+    };
+    /** The step a wallet.tempo passkey without an email needs: an emailed code, which links it. */
+    type EmailStep = {
+        /** Passed as `link` to `Actions.email.signIn`, which links the passkey to that user. */
+        link: string;
+        /** The kind of step. */
+        type: 'email';
+    };
+    /** The authorization, or the email step. */
+    type ReturnType<chainId extends number = number> = Authorization<chainId> | {
+        step: EmailStep;
+    };
+}

package/dist/actions/passkey.js

@@ -0,0 +1,46 @@
+/**
+ * Signs the user in with a passkey from the app's own sign-in form. The browser offers every passkey
+ * it holds for Tempo's domain, so the app needs no email first.
+ * @module
+ */
+import { Authentication } from 'ox/webauthn';
+import * as AccessKey from '../internal/accessKey.js';
+import * as Api from '../internal/api.js';
+import { request } from '../internal/request.js';
+/**
+ * Signs the user in with a passkey, and authorizes the app in the same call. Returns the email step
+ * for a wallet.tempo passkey whose account has no email: the app signs the user in with
+ * `Actions.email.signIn`, passing the step's `link`, which links the passkey, and the same
+ * `accessKey`, `challenge`, and `permissions`, which this call does not authorize. Throws a `RequestError` with reason
+ * `webauthn_required` when a passkey owns the Tempo Account the key acts for, since a passkey signs a
+ * key authorization only on Tempo Auth's pages. `Actions.redirect.start` authorizes it there, where
+ * the user is already signed in.
+ *
+ * @example
+ * ```ts
+ * const result = await Actions.passkey.signIn(auth)
+ * if ('step' in result) showEmailForm()
+ * ```
+ */
+export async function signIn(auth, options = {}) {
+    const { challenge, getFn, permissions } = options;
+    const key = await AccessKey.resolve(options.accessKey);
+    const requested = await Api.json(await Api.post(auth, '/v1/auth/passkey/options', { json: {} }));
+    const deserialized = Authentication.deserializeOptions(requested.options);
+    const assertion = Authentication.serializeResponse(await Authentication.sign(
+    // ox reads `getFn` beside request options at runtime, which its types admit only beside a challenge.
+    getFn ? { ...deserialized, getFn } : deserialized));
+    const body = await Api.json(await Api.post(auth, '/v1/auth/passkey/verify', {
+        json: {
+            assertion,
+            authorize: request(auth, {
+                accessKey: key.accessKey,
+                challenge,
+                permissions,
+            }),
+        },
+    }));
+    if ('step' in body)
+        return { step: body.step };
+    return Api.authorization(body.authorization, key);
+}

package/dist/actions/redirect.d.ts

@@ -45,6 +45,12 @@ export declare namespace createUrl {
          * defaults to the user's first. Defaults to a new key, whose material `pending` keeps.
          */
         accessKey?: Account.Account | undefined;
+        /**
+         * A message the owner's signature binds, such as a sign-in challenge the app's backend issued.
+         * Tempo Auth binds its EIP-191 hash as the key authorization's `witness`. Only an app with the
+         * `tempo-auth:sign` scope may send one.
+         */
+        challenge?: string | undefined;
         /** What the key may do. Tempo Auth's pages show it, and the headless ceiling fills what it leaves out. */
         permissions?: Permissions | undefined;
         /** Where Tempo Auth redirects back to. Defaults to the instance's `redirectUri`. */
@@ -97,6 +103,12 @@ export declare namespace start {
          * key, which `storage` keeps until the browser returns.
          */
         accessKey?: Account.Account | undefined;
+        /**
+         * A message the owner's signature binds, such as a sign-in challenge the app's backend issued.
+         * Tempo Auth binds its EIP-191 hash as the key authorization's `witness`. Only an app with the
+         * `tempo-auth:sign` scope may send one.
+         */
+        challenge?: string | undefined;
         /** What the key may do. Tempo Auth's pages show it, and the headless ceiling fills what it leaves out. */
         permissions?: Permissions | undefined;
     };

package/dist/actions/redirect.js

@@ -75,6 +75,9 @@ export async function createUrl(auth, options = {}) {
     });
     const url = new URL('/authorize', auth.url);
     url.search = new URLSearchParams({
+        ...(options.challenge === undefined
+            ? {}
+            : { challenge: options.challenge }),
         client_id,
         code_challenge: Base64.fromBytes(Hash.sha256(Bytes.fromString(pending.verifier)), base64url),
         key_authorization: Base64.fromString(JSON.stringify(key_authorization), base64url),

package/dist/actions/tempoAccount.js

@@ -12,8 +12,7 @@ import * as Api from '../internal/api.js';
  * ```
  */
 export async function create(auth) {
-    const { address } = await Api.json(await Api.post(auth, '/v1/account/tempo', { json: {} }));
-    return { address };
+    return toTempoAccount(await Api.json(await Api.post(auth, '/v1/account/tempo', { json: {} })));
 }
 /**
  * Lists the signed-in user's Tempo Accounts, their default first.
@@ -27,5 +26,12 @@ export async function list(auth) {
     const { tempo } = await Api.json(await (auth.fetch ?? fetch)(new URL('/v1/account', auth.url), {
         credentials: 'include',
     }));
-    return tempo.map(({ address }) => ({ address }));
+    return tempo.map(toTempoAccount);
+}
+/** Reads the account's address and the type of its owner, which the API lists first. */
+function toTempoAccount(account) {
+    return {
+        address: account.address,
+        owner: account.config.owners[0].type,
+    };
 }

package/dist/internal/request.d.ts

@@ -7,8 +7,11 @@ import type { Permissions } from '../Permissions.ts';
  */
 export declare function request(auth: Auth, options: {
     accessKey: Account.Account;
+    /** A message the key's witness binds. */
+    challenge?: string | undefined;
     permissions?: Permissions | undefined;
 }): {
+    challenge?: string;
     client_id: string;
     key_authorization: {
         account?: `0x${string}`;

package/dist/internal/request.js

@@ -9,8 +9,9 @@ import { Hex } from 'ox';
  * key account names its Tempo Account through `access`, and a plain key leaves it to Tempo Auth.
  */
 export function request(auth, options) {
-    const { accessKey, permissions = {} } = options;
+    const { accessKey, challenge, permissions = {} } = options;
     return {
+        ...(challenge === undefined ? {} : { challenge }),
         client_id: auth.clientId,
         key_authorization: {
             ...(accessKey.accessKeyAddress ? { account: accessKey.address } : {}),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tempoxyz/auth",
-  "version": "0.0.0-pr-67.sha-53ccafe",
+  "version": "0.0.0-pr-73.sha-accbf0a",
   "description": "Signs users in to Tempo through Tempo Auth, and returns Viem access key accounts on their Tempo Accounts.",
   "type": "module",
   "exports": {