@quiltt/core 4.3.2 → 4.4.0

package/CHANGELOG.md

@@ -1,5 +1,47 @@
 # @quiltt/core
 
+## 4.4.0
+
+### Minor Changes
+
+- [#378](https://github.com/quiltt/quiltt-js/pull/378) [`0af4e66`](https://github.com/quiltt/quiltt-js/commit/0af4e6622d1542e0c0c02ac7e897e3e4f9219cbd) Thanks [@sirwolfgang](https://github.com/sirwolfgang)! - Add connector institution search and provider migration support.
+
+  ## New APIs
+
+  ### `useQuilttResolvable` Hook
+
+  Check if external provider institution IDs (e.g., Plaid) can be migrated to your connector.
+
+  ```typescript
+  import { useQuilttResolvable } from "@quiltt/react";
+  import { useEffect } from "react";
+
+  function ResolvableConnector({ plaidInstitutionId, children }) {
+    const { checkResolvable, isResolvable, isLoading } =
+      useQuilttResolvable("my-connector-id");
+
+    useEffect(() => {
+      checkResolvable({ plaid: plaidInstitutionId });
+    }, [plaidInstitutionId]);
+
+    if (isLoading) return <div>Checking...</div>;
+    if (!isResolvable) return null;
+
+    return <>{children}</>;
+  }
+
+  // Usage
+  <ResolvableConnector plaidInstitutionId="ins_3">
+    <QuilttButton connectorId="my-connector-id" />
+  </ResolvableConnector>;
+  ```
+
+## 4.3.3
+
+### Patch Changes
+
+- [#375](https://github.com/quiltt/quiltt-js/pull/375) [`fdc91e3`](https://github.com/quiltt/quiltt-js/commit/fdc91e3efb3f63659580f2d1d2ea0ff7fcaee8f5) Thanks [@sirwolfgang](https://github.com/sirwolfgang)! - Add 403 callback to Auth useIdentifySession
+
 ## 4.3.2
 
 ### Patch Changes

package/dist/{SubscriptionLink-12s-BTrDDGH7.js → SubscriptionLink-12s-CoOidlX2.js}

@@ -5,7 +5,7 @@ import { createConsumer } from '@rails/actioncable';
 import { print } from 'graphql';
 
 var name = "@quiltt/core";
-var version$1 = "4.3.2";
+var version$1 = "4.4.0";
 
 const QUILTT_API_INSECURE = (()=>{
     try {

package/dist/index.d.ts

@@ -283,9 +283,14 @@ type InstitutionData = {
     logoUrl: string;
 };
 type InstitutionsData = Array<InstitutionData>;
+type ResolvableData = {
+    resolvable: boolean;
+};
 type Search = InstitutionsData | ErrorData | UnauthorizedData;
+type Resolvable = ResolvableData | ErrorData | UnauthorizedData;
 type SearchResponse = FetchResponse<InstitutionsData>;
-declare class InstitutionsAPI {
+type ResolvableResponse = FetchResponse<ResolvableData>;
+declare class ConnectorsAPI {
     clientId: string;
     agent: string;
     constructor(clientId: string, agent?: string);
@@ -293,9 +298,25 @@ declare class InstitutionsAPI {
      * Response Statuses:
      *  - 200: OK           -> Institutions Found
      *  - 401: Unauthorized -> Invalid Token
+     *  - 403: Forbidden    -> Unsupported SDK
      *  - 400: Bad Request  -> Invalid Request
      */
-    search: (token: string, connectorId: string, term: string, signal?: AbortSignal) => Promise<FetchResponse<Search>>;
+    searchInstitutions: (token: string, connectorId: string, term: string, signal?: AbortSignal) => Promise<FetchResponse<Search>>;
+    /**
+     * Response Statuses:
+     *  - 200: OK           -> Provider API ID is resolvable or not
+     *  - 401: Unauthorized -> Invalid Token
+     *  - 403: Forbidden    -> Unsupported SDK
+     *  - 400: Bad Request  -> Missing provider API ID parameter
+     *  - 404: Not Found    -> Connector not found
+     */
+    checkResolvable: (token: string, connectorId: string, providerId: {
+        plaid?: string;
+        mock?: string;
+        mx?: string;
+        finicity?: string;
+        akoya?: string;
+    }, signal?: AbortSignal) => Promise<FetchResponse<Resolvable>>;
     private config;
     private validateStatus;
 }
@@ -475,5 +496,5 @@ declare class Timeoutable {
     private broadcast;
 }
 
-export { AuthAPI, AuthLink, AuthStrategies, BatchHttpLink, ConnectorSDKEventType, ErrorLink, ForwardableLink, GlobalStorage, HttpLink, InstitutionsAPI, JsonWebTokenParse, LocalStorage, MemoryStorage, Observable, QuilttClient, RetryLink, Storage, SubscriptionLink, TerminatingLink, Timeoutable, VersionLink, cdnBase, debugging, endpointAuth, endpointGraphQL, endpointRest, endpointWebsockets, version };
-export type { BadRequestResponse, Claims, ConnectorSDK, ConnectorSDKCallbackMetadata, ConnectorSDKCallbacks, ConnectorSDKConnectOptions, ConnectorSDKConnector, ConnectorSDKConnectorOptions, ConnectorSDKOnEventCallback, ConnectorSDKOnEventExitCallback, ConnectorSDKOnExitAbortCallback, ConnectorSDKOnExitErrorCallback, ConnectorSDKOnExitSuccessCallback, ConnectorSDKOnLoadCallback, ConnectorSDKOnOpenCallback, ConnectorSDKReconnectOptions, DeepPartial, DeepReadonly, ErrorData, Exact, InputMaybe, InstitutionData, InstitutionsData, JsonWebToken, MakeMaybe, MakeOptional, Maybe, Mutable, NoContentData, Nullable, Observer, PasscodePayload, PrivateClaims, QuilttClientOptions, QuilttJWT, RegisteredClaims, SearchResponse, SessionResponse, UnauthorizedData, UnauthorizedResponse, UnprocessableData, UnprocessableResponse, UsernamePayload };
+export { AuthAPI, AuthLink, AuthStrategies, BatchHttpLink, ConnectorSDKEventType, ConnectorsAPI, ErrorLink, ForwardableLink, GlobalStorage, HttpLink, JsonWebTokenParse, LocalStorage, MemoryStorage, Observable, QuilttClient, RetryLink, Storage, SubscriptionLink, TerminatingLink, Timeoutable, VersionLink, cdnBase, debugging, endpointAuth, endpointGraphQL, endpointRest, endpointWebsockets, version };
+export type { BadRequestResponse, Claims, ConnectorSDK, ConnectorSDKCallbackMetadata, ConnectorSDKCallbacks, ConnectorSDKConnectOptions, ConnectorSDKConnector, ConnectorSDKConnectorOptions, ConnectorSDKOnEventCallback, ConnectorSDKOnEventExitCallback, ConnectorSDKOnExitAbortCallback, ConnectorSDKOnExitErrorCallback, ConnectorSDKOnExitSuccessCallback, ConnectorSDKOnLoadCallback, ConnectorSDKOnOpenCallback, ConnectorSDKReconnectOptions, DeepPartial, DeepReadonly, ErrorData, Exact, InputMaybe, InstitutionData, InstitutionsData, JsonWebToken, MakeMaybe, MakeOptional, Maybe, Mutable, NoContentData, Nullable, Observer, PasscodePayload, PrivateClaims, QuilttClientOptions, QuilttJWT, RegisteredClaims, ResolvableData, ResolvableResponse, SearchResponse, SessionResponse, UnauthorizedData, UnauthorizedResponse, UnprocessableData, UnprocessableResponse, UsernamePayload };

package/dist/index.js

@@ -1,7 +1,7 @@
 import { ApolloLink, ApolloClient } from '@apollo/client/core/index.js';
 export { gql } from '@apollo/client/core/index.js';
-import { G as GlobalStorage, e as endpointGraphQL, v as version, d as debugging, S as SubscriptionLink, a as endpointAuth, b as endpointRest } from './SubscriptionLink-12s-BTrDDGH7.js';
-export { L as LocalStorage, M as MemoryStorage, O as Observable, g as Storage, c as cdnBase, f as endpointWebsockets } from './SubscriptionLink-12s-BTrDDGH7.js';
+import { G as GlobalStorage, e as endpointGraphQL, v as version, d as debugging, S as SubscriptionLink, a as endpointAuth, b as endpointRest } from './SubscriptionLink-12s-CoOidlX2.js';
+export { L as LocalStorage, M as MemoryStorage, O as Observable, g as Storage, c as cdnBase, f as endpointWebsockets } from './SubscriptionLink-12s-CoOidlX2.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';
@@ -258,18 +258,38 @@ class AuthAPI {
     }
 }
 
-class InstitutionsAPI {
+class ConnectorsAPI {
     constructor(clientId, agent = 'web'){
         /**
    * Response Statuses:
    *  - 200: OK           -> Institutions Found
    *  - 401: Unauthorized -> Invalid Token
+   *  - 403: Forbidden    -> Unsupported SDK
    *  - 400: Bad Request  -> Invalid Request
-   */ this.search = async (token, connectorId, term, signal)=>{
+   */ this.searchInstitutions = async (token, connectorId, term, signal)=>{
             const params = new URLSearchParams();
-            params.append('connectorId', connectorId);
             params.append('term', term);
-            const response = await fetchWithRetry(`${endpointRest}/sdk/institutions?${params}`, {
+            const response = await fetchWithRetry(`${endpointRest}/sdk/connectors/${connectorId}/institutions?${params}`, {
+                method: 'GET',
+                signal,
+                ...this.config(token)
+            });
+            return response;
+        };
+        /**
+   * Response Statuses:
+   *  - 200: OK           -> Provider API ID is resolvable or not
+   *  - 401: Unauthorized -> Invalid Token
+   *  - 403: Forbidden    -> Unsupported SDK
+   *  - 400: Bad Request  -> Missing provider API ID parameter
+   *  - 404: Not Found    -> Connector not found
+   */ this.checkResolvable = async (token, connectorId, providerId, signal)=>{
+            const params = new URLSearchParams();
+            const providerKey = Object.keys(providerId)[0];
+            if (providerKey && providerId[providerKey]) {
+                params.append(providerKey, providerId[providerKey]);
+            }
+            const response = await fetchWithRetry(`${endpointRest}/sdk/connectors/${connectorId}/resolvable?${params}`, {
                 method: 'GET',
                 signal,
                 ...this.config(token)
@@ -339,4 +359,4 @@ const JsonWebTokenParse = (token)=>{
     }
 }
 
-export { AuthAPI, AuthLink, AuthStrategies, BatchHttpLink, ConnectorSDKEventType, ErrorLink, ForwardableLink, GlobalStorage, HttpLink, InstitutionsAPI, JsonWebTokenParse, QuilttClient, RetryLink, SubscriptionLink, TerminatingLink, Timeoutable, VersionLink, debugging, endpointAuth, endpointGraphQL, endpointRest, version };
+export { AuthAPI, AuthLink, AuthStrategies, BatchHttpLink, ConnectorSDKEventType, ConnectorsAPI, ErrorLink, ForwardableLink, GlobalStorage, HttpLink, JsonWebTokenParse, QuilttClient, RetryLink, SubscriptionLink, TerminatingLink, Timeoutable, VersionLink, debugging, endpointAuth, endpointGraphQL, endpointRest, version };

package/package.json

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

package/src/api/rest/connectors.ts

@@ -0,0 +1,101 @@
+import { endpointRest } from '@/configuration'
+
+import type { FetchResponse } from './fetchWithRetry'
+import { fetchWithRetry } from './fetchWithRetry'
+import type { ErrorData, UnauthorizedData } from './types'
+
+export type InstitutionData = { name: string; logoUrl: string }
+export type InstitutionsData = Array<InstitutionData>
+
+export type ResolvableData = { resolvable: boolean }
+
+type Search = InstitutionsData | ErrorData | UnauthorizedData
+type Resolvable = ResolvableData | ErrorData | UnauthorizedData
+
+export type SearchResponse = FetchResponse<InstitutionsData>
+export type ResolvableResponse = FetchResponse<ResolvableData>
+
+export class ConnectorsAPI {
+  clientId: string
+  agent: string
+
+  constructor(clientId: string, agent = 'web') {
+    this.clientId = clientId
+    this.agent = agent
+  }
+
+  /**
+   * Response Statuses:
+   *  - 200: OK           -> Institutions Found
+   *  - 401: Unauthorized -> Invalid Token
+   *  - 403: Forbidden    -> Unsupported SDK
+   *  - 400: Bad Request  -> Invalid Request
+   */
+  searchInstitutions = async (
+    token: string,
+    connectorId: string,
+    term: string,
+    signal?: AbortSignal,
+  ) => {
+    const params = new URLSearchParams()
+    params.append('term', term)
+
+    const response = await fetchWithRetry<Search>(
+      `${endpointRest}/sdk/connectors/${connectorId}/institutions?${params}`,
+      {
+        method: 'GET',
+        signal,
+        ...this.config(token),
+      },
+    )
+    return response
+  }
+
+  /**
+   * Response Statuses:
+   *  - 200: OK           -> Provider API ID is resolvable or not
+   *  - 401: Unauthorized -> Invalid Token
+   *  - 403: Forbidden    -> Unsupported SDK
+   *  - 400: Bad Request  -> Missing provider API ID parameter
+   *  - 404: Not Found    -> Connector not found
+   */
+  checkResolvable = async (
+    token: string,
+    connectorId: string,
+    providerId: { plaid?: string; mock?: string; mx?: string; finicity?: string; akoya?: string },
+    signal?: AbortSignal,
+  ) => {
+    const params = new URLSearchParams()
+
+    const providerKey = Object.keys(providerId)[0] as keyof typeof providerId
+    if (providerKey && providerId[providerKey]) {
+      params.append(providerKey, providerId[providerKey])
+    }
+
+    const response = await fetchWithRetry<Resolvable>(
+      `${endpointRest}/sdk/connectors/${connectorId}/resolvable?${params}`,
+      {
+        method: 'GET',
+        signal,
+        ...this.config(token),
+      },
+    )
+    return response
+  }
+
+  private config = (token?: string) => {
+    const headers = new Headers()
+    headers.set('Content-Type', 'application/json')
+    headers.set('Accept', 'application/json')
+    headers.set('Quiltt-SDK-Agent', this.agent)
+    headers.set('Authorization', `Bearer ${token}`)
+
+    return {
+      headers,
+      validateStatus: this.validateStatus,
+      retry: true,
+    }
+  }
+
+  private validateStatus = (status: number) => status < 500 && status !== 429
+}

package/src/api/rest/index.ts

@@ -1,3 +1,3 @@
 export * from './auth'
-export * from './institutions'
+export * from './connectors'
 export * from './types'

package/src/api/rest/institutions.ts

@@ -1,70 +0,0 @@
-import { endpointRest } from '@/configuration'
-
-import type { FetchResponse } from './fetchWithRetry'
-import { fetchWithRetry } from './fetchWithRetry'
-import type { ErrorData, UnauthorizedData } from './types'
-
-export type InstitutionData = { name: string; logoUrl: string }
-export type InstitutionsData = Array<InstitutionData>
-
-type Search = InstitutionsData | ErrorData | UnauthorizedData
-
-export type SearchResponse = FetchResponse<InstitutionsData>
-
-export class InstitutionsAPI {
-  clientId: string
-  agent: string
-
-  constructor(clientId: string, agent = 'web') {
-    this.clientId = clientId
-    this.agent = agent
-  }
-
-  /**
-   * Response Statuses:
-   *  - 200: OK           -> Institutions Found
-   *  - 401: Unauthorized -> Invalid Token
-   *  - 400: Bad Request  -> Invalid Request
-   */
-  search = async (token: string, connectorId: string, term: string, signal?: AbortSignal) => {
-    const params = new URLSearchParams()
-    params.append('connectorId', connectorId)
-    params.append('term', term)
-
-    const response = await fetchWithRetry<Search>(`${endpointRest}/sdk/institutions?${params}`, {
-      method: 'GET',
-      signal,
-      ...this.config(token),
-    })
-    return response
-  }
-
-  private config = (token?: string) => {
-    const headers = new Headers()
-    headers.set('Content-Type', 'application/json')
-    headers.set('Accept', 'application/json')
-    headers.set('Quiltt-SDK-Agent', this.agent)
-    headers.set('Authorization', `Bearer ${token}`)
-
-    return {
-      headers,
-      validateStatus: this.validateStatus,
-      retry: true,
-    }
-  }
-
-  private validateStatus = (status: number) => status < 500 && status !== 429
-
-  // private body = (payload: any) => {
-  //   if (!this.clientId) {
-  //     console.error('Quiltt Client ID is not set. Unable to identify & authenticate')
-  //   }
-
-  //   return {
-  //     session: {
-  //       clientId: this.clientId,
-  //       ...payload,
-  //     },
-  //   }
-  // }
-}