@edgeandnode/graph-auth-kit 0.2.0

package/dist/GraphAuthKit.context.d.ts

@@ -0,0 +1,80 @@
+import { QueryClient } from '@tanstack/react-query';
+import { type ReactNode } from 'react';
+import { type GraphAuthKitProps } from './types';
+export type GraphAuthKitState = {
+    /** Opens the GraphAuthKit connect modal to allow user to go through wallet connect flow */
+    openConnectModal(props?: {
+        title?: ReactNode;
+        subtitle?: ReactNode;
+        afterConnectUrl?: string;
+    }): void;
+    /** Closes the GraphAuthKit connect modal */
+    closeConnectModal(): void;
+    /** Disconnect the GraphAuthKit state. Wraps the disconnect from the useDisconnect() hook */
+    disconnect(): void | Promise<void>;
+};
+export declare const GraphAuthKitContext: import("react").Context<GraphAuthKitState>;
+export declare function useGraphAuthKit(): GraphAuthKitState;
+export type GraphAuthKitProviderProps = GraphAuthKitProps & {
+    /**
+     * [Optional]. An instantiated @tanstack/react-query `QueryClient` instance.
+     * If null, will instantiate a `QueryClient` and pass to the `QueryClientProvider`.
+     */
+    queryClient?: QueryClient;
+    /**
+     * [Optional]. Get the wagmi initial state from a cookie in the browser/api from the app rendering the `GraphAuthKitProvider`
+     */
+    initialStateCookie?: string | null;
+} & Readonly<{
+    children: ReactNode;
+}>;
+/**
+ * Builds and renders a wagmi config instance wrapped in a `WagmiProvider` context.
+ * This then wraps the `GraphAuthKitContext.Provider` which provides the connect modal state for app users to connect their wallet.
+ *
+ * **NOTE** it does NOT wrap a react-query `QueryClientProvider` instance.
+ * The app _MUST_ do this instead.
+ * react-query is responsible for query context, which wagmi uses to store account/config information.
+ * But the react-query provider can be used for querying and other uses as well.
+ *
+ * @example <caption>Configure and render the GraphAuthKit for explorer</caption>
+ * ```tsx
+ * // _app.tsx
+ *
+ * import { QueryClient } from '@tanstack/react-query'
+ * import { AppProps } from 'next'
+ * import { useRef } from 'react'
+ *
+ * import { GraphAuthKitProvider } from '@edgeandnode/graph-auth-kit'
+ *
+ * const infuraKey = process.env.INFURA_KEY!
+ * const walletConnectProjectID = process.env.WALLETCONNECT_PROJECT_ID!
+ *
+ * export default function App({ Component, router, pageProps }: AppProps) {
+ *  const queryClient = useRef<QueryClient>()
+ *  if (!queryClient.current) {
+ *    queryClient.current = new QueryClient({
+ *      defaultOptions: {
+ *        queries: {
+ *          staleTime: 60 * 1000
+ *        }
+ *      }
+ *    })
+ *  }
+ *
+ *  return (
+ *    <GraphAuthKitProvider
+ *      queryClient={queryClient.current}
+ *      infuraKey={infuraKey}
+ *      walletConnectProjectID={walletConnectProjectID}
+ *      meta={{ name: 'Graph Explorer' }}
+ *      chains="MAINNET"
+ *     >
+ *       <Component {...pageProps} />
+ *     </GraphAuthKitProvider>
+ *  )
+ * }
+ * ```
+ */
+export declare function GraphAuthKitProvider(props: GraphAuthKitProviderProps): import("react").JSX.Element;
+//# sourceMappingURL=GraphAuthKit.context.d.ts.map

package/dist/GraphAuthKit.context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GraphAuthKit.context.d.ts","sourceRoot":"","sources":["../src/GraphAuthKit.context.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAuB,MAAM,uBAAuB,CAAA;AACxE,OAAO,EAAiB,KAAK,SAAS,EAAc,MAAM,OAAO,CAAA;AASjE,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAGhD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,2FAA2F;IAC3F,gBAAgB,CAAC,KAAK,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,SAAS,CAAC;QAAC,QAAQ,CAAC,EAAE,SAAS,CAAC;QAAC,eAAe,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAA;IACrG,4CAA4C;IAC5C,iBAAiB,IAAI,IAAI,CAAA;IACzB,4FAA4F;IAC5F,UAAU,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACnC,CAAA;AAED,eAAO,MAAM,mBAAmB,4CAI9B,CAAA;AAEF,wBAAgB,eAAe,sBAE9B;AAED,MAAM,MAAM,yBAAyB,GAAG,iBAAiB,GAAG;IAC1D;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACnC,GAAG,QAAQ,CAAC;IAAE,QAAQ,EAAE,SAAS,CAAA;CAAE,CAAC,CAAA;AACrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,yBAAyB,+BAuEpE"}

package/dist/GraphAuthKitInner.context.d.ts

@@ -0,0 +1,109 @@
+import { type Dispatch, type ReactNode } from 'react';
+import { type Address } from 'viem';
+import { z } from 'zod';
+import { type SignerError } from './errors';
+import { SafeSupportedNetworks } from './safe';
+import { GraphAuthKitConnector, type RequiredInfuraKey } from './types';
+export declare const GraphAuthKitModalState: readonly ["primary", "safe_entry", "safe_eoa_signer"];
+export type GraphAuthKitModalState = (typeof GraphAuthKitModalState)[number];
+export declare const MultisigSchema: z.ZodObject<{
+    network: z.ZodType<1 | 11155111 | 42161, z.ZodTypeDef, 1 | 11155111 | 42161>;
+    address: z.ZodString;
+    enteredSafeIsValid: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    address: string;
+    network: 1 | 11155111 | 42161;
+    enteredSafeIsValid?: boolean | undefined;
+}, {
+    address: string;
+    network: 1 | 11155111 | 42161;
+    enteredSafeIsValid?: boolean | undefined;
+}>;
+export type MultisigSchema = z.infer<typeof MultisigSchema>;
+export type GraphAuthKitInnerState = {
+    /** Infura key passed down from the top-level provider/app */
+    _infuraKey: RequiredInfuraKey['infuraKey'];
+    /** The ConnectModal open state */
+    _connectModalOpen: boolean;
+    /** Open/close the ConnectModal */
+    _setConnectModalOpen: Dispatch<boolean>;
+    /**
+     * The ConnectModal title to display.
+     * @default "Connect your wallet"
+     */
+    _modalTitle: ReactNode;
+    _setModalTitle: Dispatch<ReactNode>;
+    /** The ConnectModal subtitle to display */
+    _modalSubtitle?: ReactNode;
+    _setModalSubtitle: Dispatch<ReactNode | undefined>;
+    /**
+     * Which Wallet connect options to display based off the current ConnectModal state.
+     * - 'primary' -> display the primary wallet connect options
+     * - 'safe_entry' -> the user selected to connect via their Safe multisig. Display the multisig entry form
+     * - 'safe_eoa_signer' -> let the user connect their EoA that is a signer on their entered safe
+     * @default primary
+     */
+    _modalState: GraphAuthKitModalState;
+    /** Set the current modal state of which page in the modal to display */
+    _setModalState: Dispatch<GraphAuthKitModalState>;
+    /**
+     * If the user is authenticating with a Safe, this is the entered Safe information.
+     * @default null
+     */
+    _enteredMultisigInfo?: MultisigSchema;
+    _setSafeInfo: Dispatch<MultisigSchema | undefined>;
+    /**
+     * The user has selected a Wallet connector option and is currently authenticating.
+     * If true, displays a loading indicator in the modal
+     */
+    _authenticating: boolean;
+    _setAuthenticating: Dispatch<boolean>;
+    /** The user-selected Wallet connector. */
+    _connector?: GraphAuthKitConnector;
+    /** If the connection fails, display the error message */
+    _connectFailureMessage?: SignerError;
+    /** Takes the wallet connector the user selected in the modal and connects the user to the wagmi context */
+    _connect(connector: GraphAuthKitConnector): void | Promise<void>;
+    /**
+     * If the user is connecting via a Safe multisig, take their EoA signer, connect it,
+     * and connect the Safe instance to the wagmi context.
+     */
+    _connectMultisig(params: {
+        connector: GraphAuthKitConnector;
+        network: SafeSupportedNetworks;
+        address: Address;
+    }): void | Promise<void>;
+    /** The user has disconnected their wallet. Reset the state. */
+    _reset(): void;
+};
+export declare const defInnerState: {
+    readonly _infuraKey: "";
+    readonly _connectModalOpen: false;
+    readonly _setConnectModalOpen: () => void;
+    readonly _modalTitle: "Connect your wallet";
+    readonly _setModalTitle: () => void;
+    readonly _setModalSubtitle: () => void;
+    readonly _modalState: "primary";
+    readonly _setModalState: () => void;
+    readonly _setSafeInfo: () => void;
+    readonly _authenticating: false;
+    readonly _setAuthenticating: () => void;
+    readonly _connect: () => void;
+    readonly _connectMultisig: () => void;
+    readonly _reset: () => void;
+};
+export declare const GraphAuthKitInnerContext: import("react").Context<GraphAuthKitInnerState>;
+/**
+ * We expose a minimal GraphAuthKit context state exported from this library.
+ * That way the implementer only uses the `useGraphAuthKit` hook to open/close the connect modal.
+ * Wagmi hooks should be used for all other wagmi connected auth state.
+ * This hook is not exported from this library, but is used in the ConnectModal internals
+ * to control the state of the modal itself.
+ */
+export declare function useGraphAuthKitInnerContext(): GraphAuthKitInnerState;
+export type GraphAuthKitInnerContextProviderProps = Readonly<{
+    infuraKey: RequiredInfuraKey['infuraKey'];
+    children: ReactNode;
+}>;
+export declare function GraphAuthKitInnerContextProvider({ infuraKey, children }: GraphAuthKitInnerContextProviderProps): import("react").JSX.Element;
+//# sourceMappingURL=GraphAuthKitInner.context.d.ts.map

package/dist/GraphAuthKitInner.context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GraphAuthKitInner.context.d.ts","sourceRoot":"","sources":["../src/GraphAuthKitInner.context.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,QAAQ,EAAE,KAAK,SAAS,EAAgC,MAAM,OAAO,CAAA;AAClG,OAAO,EAAE,KAAK,OAAO,EAAa,MAAM,MAAM,CAAA;AAG9C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAIvB,OAAO,EAAoB,KAAK,WAAW,EAAE,MAAM,UAAU,CAAA;AAC7D,OAAO,EAAe,qBAAqB,EAAE,MAAM,QAAQ,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,KAAK,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAEvE,eAAO,MAAM,sBAAsB,uDAAwD,CAAA;AAC3F,MAAM,MAAM,sBAAsB,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAA;AAE5E,eAAO,MAAM,cAAc;;;;;;;;;;;;EAMzB,CAAA;AACF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAE3D,MAAM,MAAM,sBAAsB,GAAG;IACnC,6DAA6D;IAC7D,UAAU,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAA;IAC1C,kCAAkC;IAClC,iBAAiB,EAAE,OAAO,CAAA;IAC1B,kCAAkC;IAClC,oBAAoB,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;IACvC;;;OAGG;IACH,WAAW,EAAE,SAAS,CAAA;IACtB,cAAc,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAA;IACnC,2CAA2C;IAC3C,cAAc,CAAC,EAAE,SAAS,CAAA;IAC1B,iBAAiB,EAAE,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC,CAAA;IAClD;;;;;;OAMG;IACH,WAAW,EAAE,sBAAsB,CAAA;IACnC,wEAAwE;IACxE,cAAc,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAA;IAChD;;;OAGG;IACH,oBAAoB,CAAC,EAAE,cAAc,CAAA;IACrC,YAAY,EAAE,QAAQ,CAAC,cAAc,GAAG,SAAS,CAAC,CAAA;IAClD;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAA;IACxB,kBAAkB,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;IACrC,0CAA0C;IAC1C,UAAU,CAAC,EAAE,qBAAqB,CAAA;IAClC,yDAAyD;IACzD,sBAAsB,CAAC,EAAE,WAAW,CAAA;IACpC,2GAA2G;IAC3G,QAAQ,CAAC,SAAS,EAAE,qBAAqB,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAChE;;;OAGG;IACH,gBAAgB,CAAC,MAAM,EAAE;QACvB,SAAS,EAAE,qBAAqB,CAAA;QAChC,OAAO,EAAE,qBAAqB,CAAA;QAC9B,OAAO,EAAE,OAAO,CAAA;KACjB,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACxB,+DAA+D;IAC/D,MAAM,IAAI,IAAI,CAAA;CACf,CAAA;AAED,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;CAeiB,CAAA;AAC3C,eAAO,MAAM,wBAAwB,iDAAuD,CAAA;AAE5F;;;;;;GAMG;AACH,wBAAgB,2BAA2B,2BAE1C;AAED,MAAM,MAAM,qCAAqC,GAAG,QAAQ,CAAC;IAC3D,SAAS,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAA;IACzC,QAAQ,EAAE,SAAS,CAAA;CACpB,CAAC,CAAA;AACF,wBAAgB,gCAAgC,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,qCAAqC,+BAoM9G"}