@quiltt/react 3.7.2 → 3.7.3

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @quiltt/react
 
+## 3.7.3
+
+### Patch Changes
+
+- [#293](https://github.com/quiltt/quiltt-js/pull/293) [`f4b48e6`](https://github.com/quiltt/quiltt-js/commit/f4b48e6db199cae4e880202c28974b481890b7c6) Thanks [@rubendinho](https://github.com/rubendinho)! - Improve documentation
+
+- Updated dependencies [[`f4b48e6`](https://github.com/quiltt/quiltt-js/commit/f4b48e6db199cae4e880202c28974b481890b7c6)]:
+  - @quiltt/core@3.7.3
+
 ## 3.7.2
 
 ### Patch Changes

package/dist/{QuilttAuthProvider-client-snQrsk82.js → QuilttAuthProvider-client-D-lSeXpV.js}

@@ -5,7 +5,7 @@ import { JsonWebTokenParse, QuilttClient, InMemoryCache as InMemoryCache$1 } fro
 import './useQuilttSettings-client-DU_Qfc8X.js';
 import './useSession-client-CG5lGS9F.js';
 import { jsx } from 'react/jsx-runtime';
-import { u as useQuilttSession } from './useQuilttSession-client-D4FPdDda.js';
+import { u as useQuilttSession } from './useQuilttSession-client-TRaUyBXB.js';
 
 function _mergeNamespaces(n, m) {
   m.forEach(function (e) {
@@ -12986,4 +12986,4 @@ const GraphQLClient = new QuilttClient({
     });
 };
 
-export { QuilttAuthProvider as Q, useImportSession as a, useIdentifySession as b, useAuthenticateSession as c, useRevokeSession as d, useApolloClient as u };
+export { GraphQLClient as G, QuilttAuthProvider as Q, useImportSession as a, useIdentifySession as b, useAuthenticateSession as c, useRevokeSession as d, useApolloClient as u };

package/dist/index.d.ts

@@ -1,8 +1,9 @@
-import { Maybe, QuilttJWT, UsernamePayload, UnprocessableData, AuthAPI, PasscodePayload, ConnectorSDKConnectorOptions, ConnectorSDKCallbacks } from '@quiltt/core';
+import { Maybe, QuilttJWT, UsernamePayload, UnprocessableData, AuthAPI, PasscodePayload, ConnectorSDKConnectorOptions, QuilttClient, ConnectorSDKCallbacks } from '@quiltt/core';
 export * from '@quiltt/core';
 import * as react from 'react';
 import { RefObject, useLayoutEffect, Dispatch, SetStateAction, FC, PropsWithChildren, Component, ComponentType } from 'react';
 import { useApolloClient } from '@apollo/client/index.js';
+import * as _apollo_client from '@apollo/client';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
 declare function useEventListener<K extends keyof MediaQueryListEventMap>(eventName: K, handler: (event: MediaQueryListEventMap[K]) => void, element: RefObject<MediaQueryList>, options?: boolean | AddEventListenerOptions): void;
@@ -107,8 +108,10 @@ declare const useQuilttSettings: () => {
 declare const useStorage: <T>(key: string, initialState?: Maybe<T>) => [Maybe<T> | undefined, Dispatch<SetStateAction<Maybe<T> | undefined>>];
 
 type QuilttAuthProviderProps = PropsWithChildren & {
+    /** The Session token obtained from the server */
     token?: string;
 };
+declare const GraphQLClient: QuilttClient<_apollo_client.NormalizedCacheObject>;
 /**
  * If a token is provided, will validate the token against the api and then import
  * it into trusted storage. While this process is happening, the component is put
@@ -119,12 +122,15 @@ type QuilttAuthProviderProps = PropsWithChildren & {
 declare const QuilttAuthProvider: FC<QuilttAuthProviderProps>;
 
 type QuilttProviderProps = PropsWithChildren & {
+    /** The client ID for the client-side Auth API */
     clientId?: string;
+    /** The Session token obtained from the server */
     token?: string;
 };
 declare const QuilttProvider: FC<QuilttProviderProps>;
 
 type QuilttSettingsProviderProps = PropsWithChildren & {
+    /** The Client ID to use for the client-side Auth API */
     clientId?: string;
 };
 declare const QuilttSettingsProvider: FC<QuilttSettingsProviderProps>;
@@ -151,4 +157,4 @@ type QuilttContainerProps<T extends AnyTag> = PropsWithChildren<{
  */
 declare const QuilttContainer: <T extends AnyTag = "div">({ as, connectorId, connectionId, onEvent, onLoad, onExit, onExitSuccess, onExitAbort, onExitError, children, ...props }: QuilttContainerProps<T> & PropsOf<T>) => react_jsx_runtime.JSX.Element;
 
-export { type AuthenticateSession, type IdentifySession, type ImportSession, QuilttAuthProvider, QuilttButton, QuilttContainer, QuilttProvider, QuilttSettings, QuilttSettingsProvider, type RevokeSession, type SetSession, type UseQuilttSession, useAuthenticateSession, useEventListener, useIdentifySession, useImportSession, useIsomorphicLayoutEffect, useQuilttClient, useQuilttConnector, useQuilttSession, useQuilttSettings, useRevokeSession, useSession, useStorage };
+export { type AuthenticateSession, GraphQLClient, type IdentifySession, type ImportSession, QuilttAuthProvider, QuilttButton, QuilttContainer, QuilttProvider, QuilttSettings, QuilttSettingsProvider, type RevokeSession, type SetSession, type UseQuilttSession, useAuthenticateSession, useEventListener, useIdentifySession, useImportSession, useIsomorphicLayoutEffect, useQuilttClient, useQuilttConnector, useQuilttSession, useQuilttSettings, useRevokeSession, useSession, useStorage };

package/dist/index.js

@@ -1,11 +1,11 @@
 export * from '@quiltt/core';
 export { u as useEventListener } from './useEventListener-client-DVM5xwKY.js';
 export { u as useIsomorphicLayoutEffect } from './useIsomorphicLayoutEffect-client-DeTHOKz1.js';
-import { Q as QuilttAuthProvider } from './QuilttAuthProvider-client-snQrsk82.js';
-export { c as useAuthenticateSession, b as useIdentifySession, a as useImportSession, d as useRevokeSession } from './QuilttAuthProvider-client-snQrsk82.js';
-export { u as useQuilttClient } from './useQuilttClient-client-BVtLOPFl.js';
-import { u as useQuilttConnector } from './useQuilttConnector-client-Bxt_mb4L.js';
-export { u as useQuilttSession } from './useQuilttSession-client-D4FPdDda.js';
+import { Q as QuilttAuthProvider } from './QuilttAuthProvider-client-D-lSeXpV.js';
+export { G as GraphQLClient, c as useAuthenticateSession, b as useIdentifySession, a as useImportSession, d as useRevokeSession } from './QuilttAuthProvider-client-D-lSeXpV.js';
+export { u as useQuilttClient } from './useQuilttClient-client-CGMZPnRI.js';
+import { u as useQuilttConnector } from './useQuilttConnector-client-BPksnYdt.js';
+export { u as useQuilttSession } from './useQuilttSession-client-TRaUyBXB.js';
 export { Q as QuilttSettings, u as useQuilttSettings } from './useQuilttSettings-client-DU_Qfc8X.js';
 export { u as useSession } from './useSession-client-CG5lGS9F.js';
 export { u as useStorage } from './useStorage-client-B3keU-oI.js';

package/dist/{useQuilttClient-client-BVtLOPFl.js → useQuilttClient-client-CGMZPnRI.js}

@@ -1,5 +1,5 @@
 'use client';
-import { u as useApolloClient } from './QuilttAuthProvider-client-snQrsk82.js';
+import { u as useApolloClient } from './QuilttAuthProvider-client-D-lSeXpV.js';
 
 const useQuilttClient = useApolloClient;
 

package/dist/{useQuilttConnector-client-Bxt_mb4L.js → useQuilttConnector-client-BPksnYdt.js}

@@ -1,11 +1,11 @@
 'use client';
 import { useState, useEffect, useCallback } from 'react';
 import { cdnBase } from '@quiltt/core';
-import { u as useQuilttSession } from './useQuilttSession-client-D4FPdDda.js';
+import { u as useQuilttSession } from './useQuilttSession-client-TRaUyBXB.js';
 import { u as useScript } from './useScript-client-Cx5nb9RW.js';
 
 // Generated by genversion.
-const version = '3.7.2';
+const version = '3.7.3';
 
 const useQuilttConnector = (connectorId, options)=>{
     const status = useScript(`${cdnBase}/v1/connector.js?agent=react-${version}`);

package/dist/{useQuilttSession-client-D4FPdDda.js → useQuilttSession-client-TRaUyBXB.js}

@@ -1,7 +1,7 @@
 'use client';
 import { useCallback } from 'react';
 import { AuthAPI } from '@quiltt/core';
-import { a as useImportSession, b as useIdentifySession, c as useAuthenticateSession, d as useRevokeSession } from './QuilttAuthProvider-client-snQrsk82.js';
+import { a as useImportSession, b as useIdentifySession, c as useAuthenticateSession, d as useRevokeSession } from './QuilttAuthProvider-client-D-lSeXpV.js';
 import { u as useQuilttSettings } from './useQuilttSettings-client-DU_Qfc8X.js';
 import { u as useSession } from './useSession-client-CG5lGS9F.js';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quiltt/react",
-  "version": "3.7.2",
+  "version": "3.7.3",
   "description": "React components and hooks for Quiltt Connector",
   "keywords": [
     "quiltt",
@@ -37,7 +37,7 @@
     "CHANGELOG.md"
   ],
   "dependencies": {
-    "@quiltt/core": "3.7.2"
+    "@quiltt/core": "3.7.3"
   },
   "devDependencies": {
     "@apollo/client": "3.9.11",

package/src/providers/QuilttAuthProvider.tsx

@@ -8,10 +8,11 @@ import { InMemoryCache, QuilttClient } from '@quiltt/core'
 import { useQuilttSession } from '../hooks'
 
 type QuilttAuthProviderProps = PropsWithChildren & {
+  /** The Session token obtained from the server */
   token?: string
 }
 
-const GraphQLClient = new QuilttClient({
+export const GraphQLClient = new QuilttClient({
   cache: new InMemoryCache(),
 })
 

package/src/providers/QuilttProvider.tsx

@@ -4,7 +4,9 @@ import { QuilttAuthProvider } from './QuilttAuthProvider'
 import { QuilttSettingsProvider } from './QuilttSettingsProvider'
 
 type QuilttProviderProps = PropsWithChildren & {
+  /** The client ID for the client-side Auth API */
   clientId?: string
+  /** The Session token obtained from the server */
   token?: string
 }
 

package/src/providers/QuilttSettingsProvider.tsx

@@ -6,6 +6,7 @@ import { useState } from 'react'
 import { QuilttSettings } from '../hooks'
 
 type QuilttSettingsProviderProps = PropsWithChildren & {
+  /** The Client ID to use for the client-side Auth API */
   clientId?: string
 }
 

package/src/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '3.7.2'
+export const version = '3.7.3'