@privy-io/react-auth 1.2.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 Horkos, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,13 @@
+# @privy-io/react-auth
+
+> **⚠️ _NOTE:_** Privy is in beta. APIs and feature sets will change. We use [Semantic Versioning](https://semver.org/) to track breaking changes.
+
+## Installing
+
+```sh
+npm i @privy-io/react-auth
+```
+
+## Contributing
+
+Looking to make changes? Check out [CONTRIBUTING.md](CONTRIBUTING.md).

package/dist/index.d.ts

@@ -0,0 +1,403 @@
+import { AxiosResponse, AxiosRequestConfig } from 'axios';
+import React from 'react';
+import { Web3Provider } from '@ethersproject/providers';
+import { AbstractProvider } from 'web3-core';
+
+/**  The types of wallet we currently support. */
+declare const SUPPORTED_WALLET_TYPES: readonly ["metamask", "coinbase_wallet", "wallet_connect"];
+declare type WalletType = typeof SUPPORTED_WALLET_TYPES[number];
+interface LinkMetadata {
+    /** Link type, most commonly useful when filtering through linkedAccounts */
+    type: 'wallet' | 'email';
+    /** Datetime when this email or wallet was associated to the user account. */
+    verifiedAt: Date;
+}
+interface Wallet {
+    /** Address of the wallet */
+    address: string;
+    /** Chain type of the wallet address */
+    chainType: 'ethereum' | 'solana';
+    /** Not yet implemented.
+     *
+     * The chain ID of the active connected wallet, if used to verify in the current session.
+     * Only present for the active wallet.
+     *
+     * e.g. testnet, mainnet, goerli */
+    chainId?: string;
+    /** Not yet implemented.
+     * The wallet type of the active connected wallet, if used to verify in the current session.
+     * Only present for the active wallet.
+     */
+    walletType?: WalletType;
+}
+interface Email {
+    /** Email address */
+    address: string;
+}
+interface WalletWithMetadata extends LinkMetadata, Wallet {
+    type: 'wallet';
+}
+interface EmailWithMetadata extends LinkMetadata, Email {
+    type: 'email';
+}
+interface User {
+    /** The Privy DID for the user. If you need to store or link additional information
+     * about a user, you can use this DID to reference the user identity. */
+    id: string;
+    /** When the user was created */
+    createdAt: Date;
+    /** The email associated with this user. It cannot be associated with another account. */
+    email?: Email;
+    /** The wallet associated with this user. It cannot be associated with another account. */
+    wallet?: Wallet;
+    /** The list of accounts associated with this user. Accounts contain additional metadata
+     * about the account and its linking that may be necessary for advanced use cases. */
+    linkedAccounts: Array<WalletWithMetadata | EmailWithMetadata>;
+}
+interface AppSettings {
+    id?: string;
+    name?: string;
+    verificationKey?: string;
+    logoUrl?: string;
+    theme?: 'System' | 'Light' | 'Dark' | string;
+    accentColor?: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+
+interface DefaultsType {
+    baseURL: string;
+    timeout: number;
+}
+/**
+ * A raw http handler for making requests to the Privy API. It requires a Session
+ * object, which is used for fetching and including any tokens that are required
+ * for requests.
+ */
+declare class Http {
+    private appId;
+    private session;
+    private defaults;
+    constructor(appId: string, session: Session, defaults: DefaultsType);
+    get<T = any, R = AxiosResponse<T>, D = any>(path: string, config?: AxiosRequestConfig<D>): Promise<R>;
+    post<T = any, R = AxiosResponse<T>, D = any>(path: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>;
+    delete<T = any, R = AxiosResponse<T>, D = any>(path: string, config?: AxiosRequestConfig<D>): Promise<R>;
+    private buildConfig;
+}
+
+interface ResponseEmailAccount {
+    type: 'email';
+    address: string;
+    verified_at: number;
+}
+interface ResponseEthereumAccount {
+    type: 'wallet';
+    address: string;
+    chain_type: 'ethereum';
+    verified_at: number;
+}
+interface GetCurrentUserResponse {
+    id: string;
+    created_at: number;
+    linked_accounts: Array<ResponseEmailAccount | ResponseEthereumAccount>;
+}
+
+/**
+ * Valid /session and <>/authenticate calls will respond with a token
+ * as well as a valid user object for streamlining.
+ */
+interface ValidSessionResponse {
+    user: GetCurrentUserResponse;
+    token: string;
+    refresh_token: string | null;
+}
+/**
+ * `Session` represents the session lifecycle of the login. It manages token
+ * storage, refresh, and deletion.
+ */
+declare class Session {
+    private destroyOnce;
+    private refreshOnce;
+    private authenticateOnce;
+    api?: Http;
+    constructor();
+    get token(): string | null;
+    get refreshToken(): string | null;
+    /**
+     * Checks to see if locally we have refresh credentials. Refresh
+     * credentials consist of:
+     *
+     *     1. Access token
+     *     2. Refresh token
+     *
+     * @returns true if we have what appear to be valid credentials, false otherwise.
+     */
+    hasRefreshCredentials(): boolean;
+    /**
+     * Checks if the session contains a valid token that is not
+     * expired or expiring soon.
+     *
+     * @returns true if token is valid and considered active, false otherwise.
+     */
+    hasActiveToken(): boolean;
+    /**
+     * Authenticate the session.
+     * @returns Promise<User>
+     */
+    authenticate(authFlow: AuthFlow): Promise<User | null>;
+    /**
+     * Renews the auth token using the refresh token.
+     * @return Promise<User> if successful with a logged-in user, Promise<null> otherwise.
+     */
+    refresh(): Promise<User | null>;
+    /**
+     * Destroy the session.
+     */
+    destroy(): Promise<void>;
+    private _authenticate;
+    private _refresh;
+    private _destroy;
+    private destroyLocalState;
+    private storeToken;
+    private storeRefreshToken;
+}
+
+declare type AuthMeta = {
+    [key: string]: any;
+};
+/**
+ * An auth flow is an encapsulation of the business logic required for a given
+ * authentication process. It requires at least one definitive `authenticate`
+ * method that does the final token handshaking with the API, but may also
+ * include any number of methods/API calls necessary to set up the state (e.g.
+ * sending an email before being able to do a passwordless code login)
+ */
+interface AuthFlow {
+    api?: Http;
+    /**
+     * Any meta information necessary for the auth flow, that may also need to be
+     * shared out to things like frontend components for displaying state of the
+     * auth flow
+     */
+    meta: AuthMeta;
+    /**
+     * Should handle the actual authentication step. An preconditions must be
+     * addressed prior to calling
+     */
+    authenticate(): Promise<ValidSessionResponse>;
+}
+
+declare global {
+    interface Window {
+        ethereum?: any;
+    }
+}
+interface EIP1193Provider {
+    request: (request: {
+        method: string;
+        params?: Array<any> | undefined;
+    }) => Promise<any>;
+    on: (eventName: string, listener: (...args: unknown[]) => void) => any;
+    removeListener: (eventName: string | symbol, listener: (...args: any[]) => void) => any;
+}
+
+declare class PrivyConnector {
+    private ethProvider;
+    walletType: WalletType | null;
+    constructor();
+    getEthereumProvider: () => EIP1193Provider;
+    initialize(): void;
+    destroy(): void;
+    /**
+     * Connects to the wallet.
+     *
+     * @param showPrompt if true, prompts the user for a connection when no connection can be automatically re-established.
+     * @param walletType? the wallet type to connect to. If not provided, defaults to the walletType that the connector was initialized with.
+     * @returns {string | null} EIP-55 mixed-case checksum-encoded address of connected wallet or null if user does not connect.
+     */
+    connect(options: {
+        showPrompt: boolean;
+    }): Promise<string | null>;
+    private isConnected;
+    private promptConnection;
+    /**
+     * The currently connected EIP-155 chain id. E.g., `1` for Ethereum mainnet.
+     *
+     * @returns {string} The EIP-155 chain id.
+     */
+    chainId(): Promise<string>;
+    /**
+     * The currently connected address.
+     *
+     * @returns {string | null} EIP-55 mixed-case checksum-encoded address or null if not connected.
+     */
+    address(): Promise<string | null>;
+}
+
+declare class PrivyClient {
+    private api;
+    private appId;
+    private session;
+    authFlow?: AuthFlow;
+    connector: PrivyConnector;
+    /**
+     * Creates a new Privy client.
+     * @param options Initialization options.
+     */
+    constructor(options: {
+        /**
+         * The URL of the Privy API. Defaults to `https://api.privy.io/v0`.
+         */
+        apiURL?: string;
+        /**
+         * The app id from your console
+         */
+        appId: string;
+        /**
+         * Time in milliseconds after which to timeout requests to the API and KMS. Defaults to `10000` (10 seconds).
+         */
+        timeout?: number;
+    });
+    authenticate(): Promise<User | null>;
+    logout(): Promise<void>;
+    startAuthFlow(authFlow: AuthFlow): void;
+    /** DATA METHODS */
+    /**
+     * Fetches the currently authenticed user from the API or
+     * returns null if the user is not authenticated.
+     *
+     * This will refresh the user's access token and rotate
+     * the refresh token if needed.
+     *
+     * @returns Promise<User | null>
+     */
+    getAuthenticatedUser(): Promise<User | null>;
+    /**
+     * Grab the Privy access token for the currently logged in user.
+     *
+     * If the token is expired or expiring soon, this will attempt to
+     * first refresh the access token to ensure that the token is active.
+     *
+     * @returns Promise<string | null>
+     */
+    getAccessToken(): Promise<string | null>;
+    getAppSettings(): Promise<AppSettings>;
+}
+
+interface PrivyProviderProps {
+    /** Your app id, taken from the Privy console. */
+    appId: string;
+    /**
+     * onSuccess is run when an auth (`login`) or linking (`linkEmail` or `linkWallet`)
+     * action is completed successfully.
+     */
+    onSuccess?: (user: User) => void;
+    children: React.ReactNode;
+}
+/**
+ * The Privy React context provider.
+ *
+ * ```typescript
+ * // At your application root:
+ * import {PrivyProvider} from '@privy-io/react-auth';
+ *
+ * <PrivyProvider appId="APP_ID_FROM_CONSOLE" onSuccess={() => console.log('Success!')}>
+ *   <Component {...pageProps} />
+ * </PrivyProvider>
+ * ```
+ */
+declare const PrivyProvider: (props: PrivyProviderProps) => JSX.Element;
+
+interface PrivyInterface {
+    /**
+     * Check whether the PrivyProvider is ready to be used. We recommend you wait for this to
+     * be true before checking values such as authenticated and user.
+     */
+    ready: boolean;
+    /**
+     * True if the user is authenticated, false if they are not. In the event that the
+     * client is offline, this will be set to true if the user has a valid token,
+     * but we are unable to fetch the user object.
+     *
+     * Note: this value should be checked in conjunction with `ready` - otherwise
+     * the value may incorrectly show authentication state while proper setup is completed.
+     */
+    authenticated: boolean;
+    /**
+     * The user object, or null if the user is not authenticated.
+     */
+    user: User | null;
+    /**
+     * Opens the Privy login modal and starts a login flow
+     */
+    login: () => void;
+    /**
+     * Opens the Privy modal and starts a flow to link an email to an already existing account.
+     */
+    linkEmail: () => void;
+    /**
+     * Opens the Privy modal and starts a flow to link a wallet to an already existing account.
+     */
+    linkWallet: () => void;
+    /**
+     * Log the current user out. This clears the user state. You can await this call to take an
+     * action once the log out is complete - for example, redirecting to a specific page.
+     */
+    logout: () => Promise<void>;
+    /**
+     * Get the Privy access token. This will automatically attempt to refresh the
+     * session if the token is expired or about to expire. You can use this to validate
+     * the user is properly authenticated on your backend with the verification key issued
+     * to your Privy app.
+     */
+    getAccessToken: () => Promise<string | null>;
+    getEthereumProvider: () => EIP1193Provider;
+    getEthersProvider: () => Web3Provider;
+    getWeb3jsProvider: () => AbstractProvider;
+}
+declare const usePrivy: () => PrivyInterface;
+
+declare abstract class PrivyError extends Error {
+    /**
+     * Privy error type.
+     */
+    abstract type: string;
+    /**
+     * Original Error object, it the error originated client-side.
+     */
+    cause?: Error;
+    /**
+     * @param type Privy error type.
+     * @param message Human-readable message.
+     * @param cause Source of this error.
+     */
+    protected constructor(message: string, cause?: unknown);
+    toString(): string;
+}
+/**
+ * Issues with the Privy api.
+ */
+declare class PrivyApiError extends PrivyError {
+    type: string;
+    /**
+     * HTTP status code, or `null` if no response was received.
+     */
+    status: number | null;
+    constructor(type: string, status: number | null, message: string, cause?: unknown);
+}
+/**
+ * Issues with the Privy client.
+ */
+declare class PrivyClientError extends PrivyError {
+    type: string;
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * The Session instance threw an exception.
+ */
+declare class PrivySessionError extends PrivyError {
+    type: string;
+    constructor(message: string, cause?: unknown);
+}
+
+export { Email, EmailWithMetadata, PrivyApiError, PrivyClient, PrivyClientError, PrivyError, PrivyProvider, PrivySessionError, User, Wallet, WalletWithMetadata, usePrivy };