@quiltt/core 3.7.2 → 3.7.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @quiltt/core
 
+## 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
+
 ## 3.7.2
 
 ### Patch Changes

package/dist/{SubscriptionLink-client-DSwo10hd.js → SubscriptionLink-client-D8TnyRwk.js}

@@ -203,7 +203,7 @@ import { print } from 'graphql';
  */ const GlobalStorage = new Storage();
 
 var name = "@quiltt/core";
-var version$1 = "3.7.2";
+var version$1 = "3.7.3";
 
 const QUILTT_API_INSECURE = (()=>{
     try {

package/dist/index.d.ts

@@ -48,35 +48,77 @@ type ConnectorSDKCallbacks = {
     onExitAbort?: ConnectorSDKOnExitAbortCallback;
     onExitError?: ConnectorSDKOnExitErrorCallback;
 };
-type ConnectorSDKOnEventCallback = (type: ConnectorSDKEventType, metadata: ConnectorSDKCallbackMetadata) => void;
+/**
+ * Callback function to handle all events from the Connector.
+ * @param type The type of event that was emitted
+ * @param metadata Metadata about the event that was emitted
+ */
+type ConnectorSDKOnEventCallback = (
+/** The type of event that was emitted */
+type: ConnectorSDKEventType, 
+/** The metadata from the event */
+metadata: ConnectorSDKCallbackMetadata) => void;
+/** Callback function to handle the Open event */
 type ConnectorSDKOnOpenCallback = (metadata: ConnectorSDKCallbackMetadata) => void;
+/** Callback function to handle the Load event */
 type ConnectorSDKOnLoadCallback = (metadata: ConnectorSDKCallbackMetadata) => void;
+/** Callback function to handle all Exit events */
 type ConnectorSDKOnEventExitCallback = (type: ConnectorSDKEventType, metadata: ConnectorSDKCallbackMetadata) => void;
+/** Callback function to handle the ExitSuccess event */
 type ConnectorSDKOnExitSuccessCallback = (metadata: ConnectorSDKCallbackMetadata) => void;
+/** Callback function to handle the ExitAbort event */
 type ConnectorSDKOnExitAbortCallback = (metadata: ConnectorSDKCallbackMetadata) => void;
+/** Callback function to handle the ExitError event */
 type ConnectorSDKOnExitErrorCallback = (metadata: ConnectorSDKCallbackMetadata) => void;
+/**
+ * Enum representing the different types of events emitted by the Connector.
+ */
 declare enum ConnectorSDKEventType {
+    /** The Connector modal has been opened */
     Open = "opened",
+    /** The Connector has loaded successfully */
     Load = "loaded",
+    /** The end-user successfully completed the flow */
     ExitSuccess = "exited.successful",
+    /** The end-user exited the Connector before completing the flow */
     ExitAbort = "exited.aborted",
+    /** The end-user experienced an error during the flow */
     ExitError = "exited.errored"
 }
+/**
+ * Metadata about a Connector event
+ * @param connectorId The ID of the Connector that emitted the event
+ * @param profileId The ID of the authenticated Profile
+ * @param connectionId The ID of the Connection that was created or reconnected
+ */
 type ConnectorSDKCallbackMetadata = {
+    /** The ID of the Connector that emitted the event */
     connectorId: string;
+    /** The ID of the authenticated Profile */
     profileId?: string;
+    /** The ID of the Connection that was created or reconnected */
     connectionId?: string;
 };
+/**
+  Options for the standard Connect flow
+  @param institution The Institution search term or ID to preload
+*/
 type ConnectorSDKConnectOptions = ConnectorSDKCallbacks & {
+    /** The Institution search term or ID to preload */
     institution?: string;
+    /** The ID of the Connection to reconnect */
+    connectionId?: string;
 };
+/**
+ * Options for the Reconnect flow
+ * @param connectionId The ID of the Connection to reconnect
+ */
 type ConnectorSDKReconnectOptions = ConnectorSDKCallbacks & {
+    /** The ID of the Connection to reconnect */
     connectionId: string;
 };
-type ConnectorSDKConnectorOptions = ConnectorSDKCallbacks & {
-    institution?: string;
-    connectionId?: string;
-};
+/** Options to initialize Connector */
+type ConnectorSDKConnectorOptions = ConnectorSDKConnectOptions | ConnectorSDKConnectOptions;
 
 /**
  * unauthorizedCallback only triggers in the event the token is present, and

package/dist/index.js

@@ -1,7 +1,7 @@
 import { ApolloLink, ApolloClient } from '@apollo/client/index.js';
 export { InMemoryCache, gql, useMutation, useQuery, useSubscription } from '@apollo/client/index.js';
-import { G as GlobalStorage, e as endpointGraphQL, v as version, d as debugging, S as SubscriptionLink, a as endpointAuth } from './SubscriptionLink-client-DSwo10hd.js';
-export { L as LocalStorage, M as MemoryStorage, O as Observable, b as Storage, c as cdnBase, f as endpointWebsockets } from './SubscriptionLink-client-DSwo10hd.js';
+import { G as GlobalStorage, e as endpointGraphQL, v as version, d as debugging, S as SubscriptionLink, a as endpointAuth } from './SubscriptionLink-client-D8TnyRwk.js';
+export { L as LocalStorage, M as MemoryStorage, O as Observable, b as Storage, c as cdnBase, f as endpointWebsockets } from './SubscriptionLink-client-D8TnyRwk.js';
 import { BatchHttpLink as BatchHttpLink$1 } from '@apollo/client/link/batch-http/index.js';
 import crossfetch from 'cross-fetch';
 import { onError } from '@apollo/client/link/error/index.js';
@@ -10,11 +10,11 @@ import { RetryLink as RetryLink$1 } from '@apollo/client/link/retry/index.js';
 
 var ConnectorSDKEventType;
 (function(ConnectorSDKEventType) {
-    ConnectorSDKEventType["Open"] = "opened";
-    ConnectorSDKEventType["Load"] = "loaded";
-    ConnectorSDKEventType["ExitSuccess"] = "exited.successful";
-    ConnectorSDKEventType["ExitAbort"] = "exited.aborted";
-    ConnectorSDKEventType["ExitError"] = "exited.errored";
+    /** The Connector modal has been opened */ ConnectorSDKEventType["Open"] = "opened";
+    /** The Connector has loaded successfully */ ConnectorSDKEventType["Load"] = "loaded";
+    /** The end-user successfully completed the flow */ ConnectorSDKEventType["ExitSuccess"] = "exited.successful";
+    /** The end-user exited the Connector before completing the flow */ ConnectorSDKEventType["ExitAbort"] = "exited.aborted";
+    /** The end-user experienced an error during the flow */ ConnectorSDKEventType["ExitError"] = "exited.errored";
 })(ConnectorSDKEventType || (ConnectorSDKEventType = {}));
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quiltt/core",
-  "version": "3.7.2",
+  "version": "3.7.3",
   "description": "Javascript API client and utilities for Quiltt",
   "keywords": [
     "quiltt",

package/src/api/browser.ts

@@ -45,46 +45,93 @@ export type ConnectorSDKCallbacks = {
   onExitError?: ConnectorSDKOnExitErrorCallback
 }
 
+/**
+ * Callback function to handle all events from the Connector.
+ * @param type The type of event that was emitted
+ * @param metadata Metadata about the event that was emitted
+ */
 export type ConnectorSDKOnEventCallback = (
+  /** The type of event that was emitted */
   type: ConnectorSDKEventType,
+  /** The metadata from the event */
   metadata: ConnectorSDKCallbackMetadata
 ) => void
 
+/** Callback function to handle the Open event */
 export type ConnectorSDKOnOpenCallback = (metadata: ConnectorSDKCallbackMetadata) => void
+
+/** Callback function to handle the Load event */
 export type ConnectorSDKOnLoadCallback = (metadata: ConnectorSDKCallbackMetadata) => void
 
+/** Callback function to handle all Exit events */
 export type ConnectorSDKOnEventExitCallback = (
   type: ConnectorSDKEventType,
   metadata: ConnectorSDKCallbackMetadata
 ) => void
 
+/** Callback function to handle the ExitSuccess event */
 export type ConnectorSDKOnExitSuccessCallback = (metadata: ConnectorSDKCallbackMetadata) => void
+
+/** Callback function to handle the ExitAbort event */
 export type ConnectorSDKOnExitAbortCallback = (metadata: ConnectorSDKCallbackMetadata) => void
+
+/** Callback function to handle the ExitError event */
 export type ConnectorSDKOnExitErrorCallback = (metadata: ConnectorSDKCallbackMetadata) => void
 
+/**
+ * Enum representing the different types of events emitted by the Connector.
+ */
 export enum ConnectorSDKEventType {
+  /** The Connector modal has been opened */
   Open = 'opened',
+
+  /** The Connector has loaded successfully */
   Load = 'loaded',
+
+  /** The end-user successfully completed the flow */
   ExitSuccess = 'exited.successful',
+
+  /** The end-user exited the Connector before completing the flow */
   ExitAbort = 'exited.aborted',
+
+  /** The end-user experienced an error during the flow */
   ExitError = 'exited.errored',
 }
 
+/**
+ * Metadata about a Connector event
+ * @param connectorId The ID of the Connector that emitted the event
+ * @param profileId The ID of the authenticated Profile
+ * @param connectionId The ID of the Connection that was created or reconnected
+ */
 export type ConnectorSDKCallbackMetadata = {
+  /** The ID of the Connector that emitted the event */
   connectorId: string
+  /** The ID of the authenticated Profile */
   profileId?: string
+  /** The ID of the Connection that was created or reconnected */
   connectionId?: string
 }
 
+/**
+  Options for the standard Connect flow
+  @param institution The Institution search term or ID to preload
+*/
 export type ConnectorSDKConnectOptions = ConnectorSDKCallbacks & {
+  /** The Institution search term or ID to preload */
   institution?: string
+  /** The ID of the Connection to reconnect */
+  connectionId?: string
 }
 
+/**
+ * Options for the Reconnect flow
+ * @param connectionId The ID of the Connection to reconnect
+ */
 export type ConnectorSDKReconnectOptions = ConnectorSDKCallbacks & {
+  /** The ID of the Connection to reconnect */
   connectionId: string
 }
 
-export type ConnectorSDKConnectorOptions = ConnectorSDKCallbacks & {
-  institution?: string
-  connectionId?: string
-}
+/** Options to initialize Connector */
+export type ConnectorSDKConnectorOptions = ConnectorSDKConnectOptions | ConnectorSDKConnectOptions