@tempoxyz/auth 0.0.0-pr-62.sha-55672b2 → 0.0.0-pr-62.sha-8ef1ef2

package/README.md

@@ -1,6 +1,6 @@
 # @tempoxyz/auth
 
-Signs users in to Tempo through [Tempo Auth](../../docs/README.md), and returns their tokens for Tempo APIs and a [viem](https://viem.sh) access key account on their Tempo Account.
+Signs users in to Tempo through [Tempo Auth](../../docs/README.md), and returns their tokens for Tempo APIs and a [Viem](https://viem.sh) access key account on their Tempo Account.
 
 ## Overview
 
@@ -15,7 +15,6 @@ const ousd = Tokens.ousd(client.chain.id).address
 const auth = Auth.create({
   chainId: client.chain.id,
   clientId: 'client_…',
-  url: 'https://auth.tempo.xyz',
 })
 
 // 1. Email the user a sign-in code.
@@ -44,7 +43,7 @@ else
   })
 ```
 
-Every sign-in returns the same `Authorization`. Its `account` sends transactions through viem, and its `accessToken` calls Tempo APIs.
+Every sign-in returns the same `Authorization`. Its `account` sends transactions through Viem, and its `accessToken` calls Tempo APIs.
 
 ## Install
 
@@ -54,6 +53,6 @@ pnpm add @tempoxyz/auth viem
 
 ## Documentation
 
-- [Guides](docs/guides/README.md): each sign-in flow, access keys, sessions, errors, and viem.
+- [Guides](docs/guides/README.md): each sign-in flow, access keys, sessions, errors, and Viem.
 - [API reference](docs/api/README.md): every action, function, and type.
 - [Tempo Auth](../../docs/README.md): the service the package calls, over HTTP.

package/dist/Actions.d.ts

@@ -28,7 +28,7 @@ export declare function authorize(auth: Auth, options?: authorize.Options): Prom
 export declare namespace authorize {
     type Options = {
         /**
-         * The key to authorize, as a viem account. Its `access` names the Tempo Account, which
+         * 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;

package/dist/Auth.d.ts

@@ -1,3 +1,31 @@
+/**
+ * A Tempo Auth instance, which every action takes. Create one with {@link create}, then pass it
+ * to each action in `Actions`. Every sign-in returns an `Authorization`: the user's tokens and a
+ * Viem access key account.
+ *
+ * @example
+ * ```ts
+ * import { Actions, Auth } from '@tempoxyz/auth'
+ * import { Expiry, Scopes } from 'viem/tempo'
+ * import { tempo } from 'viem/tempo/chains'
+ * import * as Tokens from 'viem/tokens'
+ *
+ * // OUSD has its mainnet address on every Tempo chain.
+ * const ousd = Tokens.ousd(tempo.id).address
+ *
+ * const auth = Auth.create({ clientId: 'client_…', testnet: true })
+ *
+ * const authorization = await Actions.authorize(auth, {
+ *   permissions: {
+ *     expiry: Expiry.days(1),
+ *     limits: [{ limit: 10_000_000n, token: ousd }],
+ *     scopes: [Scopes.tip20(ousd).transfer()],
+ *   },
+ * })
+ * ```
+ * @module
+ */
+import type { OneOf } from 'viem';
 import type { Storage } from './Storage.ts';
 /** A Tempo Auth instance, which every action takes. */
 export type Auth = {
@@ -18,7 +46,7 @@ export type Auth = {
      * objects as they are, since a browser key is a `CryptoKey`. Defaults to IndexedDB.
      */
     storage?: Storage | undefined;
-    /** Where Tempo Auth runs, such as `https://auth.tempo.xyz`. */
+    /** Where Tempo Auth runs, such as `https://auth.tech.dev`. */
     url: string;
 };
 /** A request Tempo Auth refused, with its status and message. */
@@ -56,18 +84,24 @@ export declare namespace RequestError {
  *
  * @example
  * ```ts
- * const auth = Auth.create({ clientId: 'client_…', url: 'https://auth.tempo.xyz' })
+ * const auth = Auth.create({ clientId: 'client_…' })
  * ```
  */
 export declare function create(options: create.Options): Auth;
 export declare namespace create {
-    type Options = Omit<Auth, 'chainId' | 'scope'> & {
-        /** The chain the app's keys act on, such as `tempoTestnet.id`. Defaults to Tempo mainnet. */
-        chainId?: number | undefined;
+    type Options = Omit<Auth, 'chainId' | 'scope' | 'url'> & {
         /**
          * Scopes the app's tokens carry beyond `openid` and `email`, which every instance includes.
          * Defaults to `offline_access`, for a refresh token.
          */
         scope?: string | undefined;
-    };
+        /** Where Tempo Auth runs. Defaults to `https://auth.tech.dev`. */
+        url?: string | undefined;
+    } & OneOf<{
+        /** The chain the app's keys act on, such as `client.chain.id`. Defaults to Tempo mainnet. */
+        chainId?: number | undefined;
+    } | {
+        /** Whether the app's keys act on Tempo testnet instead of Tempo mainnet. Defaults to `false`. */
+        testnet?: boolean | undefined;
+    }>;
 }

package/dist/Auth.js

@@ -1,34 +1,4 @@
-/**
- * A Tempo Auth instance, which every action takes. Create one with {@link create}, then pass it
- * to each action in `Actions`. Every sign-in returns an `Authorization`: the user's tokens and a
- * viem access key account.
- *
- * @example
- * ```ts
- * import { Actions, Auth } from '@tempoxyz/auth'
- * import { Expiry, Scopes } from 'viem/tempo'
- * import { tempo, tempoTestnet } from 'viem/tempo/chains'
- * import * as Tokens from 'viem/tokens'
- *
- * const ousd = Tokens.ousd(tempo.id).address
- *
- * const auth = Auth.create({
- *   chainId: tempoTestnet.id,
- *   clientId: 'client_…',
- *   url: 'https://auth.tempo.xyz',
- * })
- *
- * const authorization = await Actions.authorize(auth, {
- *   permissions: {
- *     expiry: Expiry.days(1),
- *     limits: [{ limit: 10_000_000n, token: ousd }],
- *     scopes: [Scopes.tip20(ousd).transfer()],
- *   },
- * })
- * ```
- * @module
- */
-import { tempo } from 'viem/tempo/chains';
+import { tempo, tempoTestnet } from 'viem/tempo/chains';
 /** A request Tempo Auth refused, with its status and message. */
 export class RequestError extends Error {
     name = 'Auth.RequestError';
@@ -59,15 +29,19 @@ export class RequestError extends Error {
  *
  * @example
  * ```ts
- * const auth = Auth.create({ clientId: 'client_…', url: 'https://auth.tempo.xyz' })
+ * const auth = Auth.create({ clientId: 'client_…' })
  * ```
  */
 export function create(options) {
+    const { chainId, scope = 'offline_access', testnet, url, ...rest } = options;
     // Every authorization reads the user from the ID token, which needs `openid` and `email`.
-    const scopes = (options.scope ?? 'offline_access').split(' ').filter(Boolean);
+    const scopes = scope.split(' ').filter(Boolean);
     return {
-        ...options,
-        chainId: options.chainId ?? tempo.id,
+        ...rest,
+        chainId: chainId ?? (testnet ? tempoTestnet.id : tempo.id),
         scope: [...new Set(['openid', 'email', ...scopes])].join(' '),
+        url: url ?? defaultUrl,
     };
 }
+/** Where Tempo Auth runs unless `create` receives a `url`. */
+const defaultUrl = 'https://auth.tech.dev';

package/dist/Authorization.d.ts

@@ -7,7 +7,7 @@ import type { Tokens } from './Tokens.ts';
 import type { User } from './User.ts';
 /** What every sign-in returns: the app's tokens for Tempo APIs, with its access key and the user. */
 export type Authorization = Tokens & {
-    /** The user's Tempo Account, as a viem account that signs with the app's access key. */
+    /** The user's Tempo Account, as a Viem account that signs with the app's access key. */
     account: ReturnType<typeof Key.toAccount>;
     /** The same key as data, for apps that store it and rebuild it with `Key.toAccount`. */
     key: Key.Key;

package/dist/Key.d.ts

@@ -50,7 +50,7 @@ export declare function expired(key: Key): boolean;
  */
 export declare function from(value: Key): Key;
 /**
- * Returns the key as a viem access key account acting for its Tempo Account. viem attaches the
+ * Returns the key as a Viem access key account acting for its Tempo Account. Viem attaches the
  * authorization to transactions until the chain registers the key. A key the app supplied signs
  * with that `accessKey`. Throws {@link AccessKeyRequiredError} when neither holds key material.
  *

package/dist/Key.js

@@ -37,7 +37,7 @@ export function from(value) {
     return value;
 }
 /**
- * Returns the key as a viem access key account acting for its Tempo Account. viem attaches the
+ * Returns the key as a Viem access key account acting for its Tempo Account. Viem attaches the
  * authorization to transactions until the chain registers the key. A key the app supplied signs
  * with that `accessKey`. Throws {@link AccessKeyRequiredError} when neither holds key material.
  *

package/dist/Permissions.d.ts

@@ -4,13 +4,13 @@
  */
 import type { KeyAuthorization } from 'ox/tempo';
 /**
- * What an app's access key may do, as viem's `accessKey.authorize` takes it. Tempo Auth fills what
+ * What an app's access key may do, as Viem's `accessKey.authorize` takes it. Tempo Auth fills what
  * it leaves out with the headless ceiling.
  */
 export type Permissions = {
     /** The chain the key acts on, such as `tempoTestnet.id`. Defaults to the instance's `chainId`. */
     chainId?: number | undefined;
-    /** Unix seconds. viem's `Expiry` builds one, such as `Expiry.days(1)`. Defaults to a year from now. */
+    /** Unix seconds. Viem's `Expiry` builds one, such as `Expiry.days(1)`. Defaults to a year from now. */
     expiry?: number | undefined;
     /** How much of each token the key may spend. Defaults to about $1,000 of each token it calls, or of OUSD. */
     limits?: KeyAuthorization.KeyAuthorization['limits'];

package/dist/actions/device.d.ts

@@ -17,7 +17,7 @@ export declare function authorize(auth: Auth, options: authorize.Options): Promi
 export declare namespace authorize {
     type Options = {
         /**
-         * The key to authorize, as a viem account. Its `access` names the Tempo Account, which
+         * 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;

package/dist/actions/email.d.ts

@@ -36,7 +36,7 @@ export declare function signIn(auth: Auth, options: signIn.Options): Promise<sig
 export declare namespace signIn {
     type Options = {
         /**
-         * The key to authorize, as a viem account. Its `access` names the Tempo Account, which
+         * 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;

package/dist/actions/redirect.d.ts

@@ -41,7 +41,7 @@ export declare function createUrl(auth: Auth, options?: createUrl.Options): Prom
 export declare namespace createUrl {
     type Options = {
         /**
-         * The key to authorize, as a viem account. Its `access` names the Tempo Account, which
+         * 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, whose material `pending` keeps.
          */
         accessKey?: Account.Account | undefined;
@@ -93,7 +93,7 @@ export declare function start(auth: Auth, options?: start.Options): Promise<void
 export declare namespace start {
     type Options = {
         /**
-         * The key to authorize, as a viem account. Pass it to {@link complete} too. Defaults to a new
+         * The key to authorize, as a Viem account. Pass it to {@link complete} too. Defaults to a new
          * key, which `storage` keeps until the browser returns.
          */
         accessKey?: Account.Account | undefined;

package/dist/internal/accessKey.d.ts

@@ -7,7 +7,7 @@ import type * as Key from '../Key.ts';
 export declare function resolve(accessKey: Account.Account | undefined): Promise<resolve.ReturnType>;
 export declare namespace resolve {
     type ReturnType = {
-        /** The key, as a viem account that signs with it. */
+        /** The key, as a Viem account that signs with it. */
         accessKey: Account.Account;
         /** What the authorization keeps to rebuild the key. Empty for a key the app supplied. */
         material: Key.Material;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tempoxyz/auth",
-  "version": "0.0.0-pr-62.sha-55672b2",
-  "description": "Signs users in to Tempo through Tempo Auth, and returns viem access key accounts on their Tempo Accounts.",
+  "version": "0.0.0-pr-62.sha-8ef1ef2",
+  "description": "Signs users in to Tempo through Tempo Auth, and returns Viem access key accounts on their Tempo Accounts.",
   "type": "module",
   "exports": {
     ".": {