@quiltt/core 4.0.1 → 4.1.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @quiltt/core
 
+## 4.1.0
+
+### Minor Changes
+
+- [#342](https://github.com/quiltt/quiltt-js/pull/342) [`6a387ba`](https://github.com/quiltt/quiltt-js/commit/6a387ba0db77912df85c6cd1924f63edf50f9cdd) Thanks [@sirwolfgang](https://github.com/sirwolfgang)! - Create useQuilttInstitutions hook
+
 ## 4.0.1
 
 ### Patch Changes

package/dist/{SubscriptionLink-client-CVjwwmoB.js → SubscriptionLink-client-BS9H6eZn.js}

@@ -204,7 +204,7 @@ import { print } from 'graphql';
  */ const GlobalStorage = new Storage();
 
 var name = "@quiltt/core";
-var version$1 = "4.0.1";
+var version$1 = "4.1.0";
 
 const QUILTT_API_INSECURE = (()=>{
     try {
@@ -235,6 +235,7 @@ const version = `${name}: v${version$1}`;
 const cdnBase = `${protocolHttp}://cdn.${domain}`;
 const endpointAuth = `${protocolHttp}://auth.${domain}/v1/users/session`;
 const endpointGraphQL = `${protocolHttp}://api.${domain}/v1/graphql`;
+const endpointRest = `${protocolHttp}://api.${domain}/v1`;
 const endpointWebsockets = `${protocolWebsockets}://api.${domain}/websockets`;
 
 class ActionCableLink extends ApolloLink {
@@ -298,4 +299,4 @@ class SubscriptionLink extends ActionCableLink {
     }
 }
 
-export { GlobalStorage as G, LocalStorage as L, MemoryStorage as M, Observable as O, SubscriptionLink as S, endpointAuth as a, Storage as b, cdnBase as c, debugging as d, endpointGraphQL as e, endpointWebsockets as f, version as v };
+export { GlobalStorage as G, LocalStorage as L, MemoryStorage as M, Observable as O, SubscriptionLink as S, endpointAuth as a, endpointRest as b, Storage as c, debugging as d, endpointGraphQL as e, cdnBase as f, endpointWebsockets as g, version as v };

package/dist/index.d.ts

@@ -191,6 +191,23 @@ type FetchResponse<T> = {
     ok: boolean;
 };
 
+type NoContentData = null;
+type ErrorData = {
+    message: string;
+    instruction: string;
+    error_id: string;
+};
+type UnauthorizedData = {
+    message: string;
+    instruction: string;
+};
+type UnprocessableData = {
+    [attribute: string]: Array<string>;
+};
+type BadRequestResponse = FetchResponse<ErrorData>;
+type UnauthorizedResponse = FetchResponse<UnauthorizedData>;
+type UnprocessableResponse = FetchResponse<UnprocessableData>;
+
 declare enum AuthStrategies {
     Email = "email",
     Phone = "phone"
@@ -210,20 +227,11 @@ type PasscodePayload = UsernamePayload & {
 type SessionData = {
     token: string;
 };
-type NoContentData = null;
-type UnauthorizedData = {
-    message: string;
-    instruction: string;
-};
-type UnprocessableData = {
-    [attribute: string]: Array<string>;
-};
 type Ping = SessionData | UnauthorizedData;
 type Identify = SessionData | NoContentData | UnprocessableData;
 type Authenticate = SessionData | UnauthorizedData | UnprocessableData;
 type Revoke = NoContentData | UnauthorizedData;
 type SessionResponse = FetchResponse<SessionData>;
-type UnprocessableResponse = FetchResponse<UnprocessableData>;
 declare class AuthAPI {
     clientId: string | undefined;
     constructor(clientId?: string | undefined);
@@ -258,6 +266,29 @@ declare class AuthAPI {
     private body;
 }
 
+type InstitutionData = {
+    name: string;
+    logoUrl: string;
+};
+type InstitutionsData = Array<InstitutionData>;
+type Search = InstitutionsData | ErrorData | UnauthorizedData;
+type SearchResponse = FetchResponse<InstitutionsData>;
+declare class InstitutionsAPI {
+    clientId: string;
+    agent: string;
+    constructor(clientId: string, agent?: string);
+    /**
+     * Response Statuses:
+     *  - 200: OK           -> Institutions Found
+     *  - 401: Unauthorized -> Invalid Token
+     *  - 400: Bad Request  -> Invalid Request
+     */
+    search: (token: string, connectorId: string, term: string, signal?: AbortSignal) => Promise<FetchResponse<Search>>;
+    private config;
+    private validateStatus;
+    private body;
+}
+
 /** Utility types to extend default TS utilities */
 type Maybe<T> = T | null;
 type InputMaybe<T> = Maybe<T>;
@@ -383,6 +414,7 @@ declare const version: string;
 declare const cdnBase: string;
 declare const endpointAuth: string;
 declare const endpointGraphQL: string;
+declare const endpointRest: string;
 declare const endpointWebsockets: string;
 
 type RegisteredClaims = {
@@ -422,5 +454,5 @@ declare class Timeoutable {
     private broadcast;
 }
 
-export { AuthAPI, AuthLink, AuthStrategies, BatchHttpLink, ConnectorSDKEventType, ErrorLink, ForwardableLink, GlobalStorage, HttpLink, JsonWebTokenParse, LocalStorage, MemoryStorage, Observable, QuilttClient, RetryLink, Storage, SubscriptionLink, TerminatingLink, Timeoutable, VersionLink, cdnBase, debugging, endpointAuth, endpointGraphQL, endpointWebsockets, version };
-export type { Claims, ConnectorSDK, ConnectorSDKCallbackMetadata, ConnectorSDKCallbacks, ConnectorSDKConnectOptions, ConnectorSDKConnector, ConnectorSDKConnectorOptions, ConnectorSDKOnEventCallback, ConnectorSDKOnEventExitCallback, ConnectorSDKOnExitAbortCallback, ConnectorSDKOnExitErrorCallback, ConnectorSDKOnExitSuccessCallback, ConnectorSDKOnLoadCallback, ConnectorSDKOnOpenCallback, ConnectorSDKReconnectOptions, DeepPartial, DeepReadonly, Exact, InputMaybe, JsonWebToken, MakeMaybe, MakeOptional, Maybe, Mutable, Nullable, Observer, PasscodePayload, PrivateClaims, QuilttClientOptions, QuilttJWT, RegisteredClaims, SessionResponse, UnprocessableData, UnprocessableResponse, UsernamePayload };
+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 };

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 } from './SubscriptionLink-client-CVjwwmoB.js';
-export { L as LocalStorage, M as MemoryStorage, O as Observable, b as Storage, c as cdnBase, f as endpointWebsockets } from './SubscriptionLink-client-CVjwwmoB.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-client-BS9H6eZn.js';
+export { L as LocalStorage, M as MemoryStorage, O as Observable, c as Storage, f as cdnBase, g as endpointWebsockets } from './SubscriptionLink-client-BS9H6eZn.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';
@@ -254,6 +254,53 @@ class AuthAPI {
     }
 }
 
+class InstitutionsAPI {
+    constructor(clientId, agent = 'web'){
+        /**
+   * Response Statuses:
+   *  - 200: OK           -> Institutions Found
+   *  - 401: Unauthorized -> Invalid Token
+   *  - 400: Bad Request  -> Invalid Request
+   */ this.search = 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}`, {
+                method: 'GET',
+                signal,
+                ...this.config(token)
+            });
+            return response;
+        };
+        this.config = (token)=>{
+            const headers = new Headers();
+            headers.set('Content-Type', 'application/json');
+            headers.set('Accept', 'application/json');
+            headers.set('X-Quiltt-SDK-Agent', this.agent);
+            headers.set('Authorization', `Bearer ${token}`);
+            return {
+                headers,
+                validateStatus: this.validateStatus,
+                retry: true
+            };
+        };
+        this.validateStatus = (status)=>status < 500 && status !== 429;
+        this.body = (payload)=>{
+            if (!this.clientId) {
+                console.error('Quiltt Client ID is not set. Unable to identify & authenticate');
+            }
+            return {
+                session: {
+                    clientId: this.clientId,
+                    ...payload
+                }
+            };
+        };
+        this.clientId = clientId;
+        this.agent = agent;
+    }
+}
+
 const MATCHER = /^(?:[\w-]+\.){2}[\w-]+$/;
 const JsonWebTokenParse = (token)=>{
     if (typeof token === 'undefined' || token === null) return token;
@@ -296,4 +343,4 @@ const JsonWebTokenParse = (token)=>{
     }
 }
 
-export { AuthAPI, AuthLink, AuthStrategies, BatchHttpLink, ConnectorSDKEventType, ErrorLink, ForwardableLink, GlobalStorage, HttpLink, JsonWebTokenParse, QuilttClient, RetryLink, SubscriptionLink, TerminatingLink, Timeoutable, VersionLink, debugging, endpointAuth, endpointGraphQL, version };
+export { AuthAPI, AuthLink, AuthStrategies, BatchHttpLink, ConnectorSDKEventType, ErrorLink, ForwardableLink, GlobalStorage, HttpLink, InstitutionsAPI, JsonWebTokenParse, QuilttClient, RetryLink, SubscriptionLink, TerminatingLink, Timeoutable, VersionLink, debugging, endpointAuth, endpointGraphQL, endpointRest, version };

package/package.json

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

package/src/api/rest/auth.ts

@@ -1,6 +1,8 @@
 import { endpointAuth } from '@/configuration'
+
 import type { FetchResponse } from './fetchWithRetry'
 import { fetchWithRetry } from './fetchWithRetry'
+import type { NoContentData, UnauthorizedData, UnprocessableData } from './types'
 
 export enum AuthStrategies {
   Email = 'email',
@@ -21,9 +23,6 @@ export type UsernamePayload = EmailInput | PhoneInput
 export type PasscodePayload = UsernamePayload & { passcode: string }
 
 type SessionData = { token: string }
-type NoContentData = null
-type UnauthorizedData = { message: string; instruction: string }
-export type UnprocessableData = { [attribute: string]: Array<string> }
 
 type Ping = SessionData | UnauthorizedData
 type Identify = SessionData | NoContentData | UnprocessableData
@@ -31,7 +30,6 @@ type Authenticate = SessionData | UnauthorizedData | UnprocessableData
 type Revoke = NoContentData | UnauthorizedData
 
 export type SessionResponse = FetchResponse<SessionData>
-export type UnprocessableResponse = FetchResponse<UnprocessableData>
 
 // https://www.quiltt.dev/api-reference/auth
 export class AuthAPI {

package/src/api/rest/index.ts

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

package/src/api/rest/institutions.ts

@@ -0,0 +1,70 @@
+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('X-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,
+      },
+    }
+  }
+}

package/src/api/rest/types.ts

@@ -0,0 +1,10 @@
+import type { FetchResponse } from './fetchWithRetry'
+
+export type NoContentData = null
+export type ErrorData = { message: string; instruction: string; error_id: string }
+export type UnauthorizedData = { message: string; instruction: string }
+export type UnprocessableData = { [attribute: string]: Array<string> }
+
+export type BadRequestResponse = FetchResponse<ErrorData>
+export type UnauthorizedResponse = FetchResponse<UnauthorizedData>
+export type UnprocessableResponse = FetchResponse<UnprocessableData>

package/src/configuration.ts

@@ -34,4 +34,5 @@ export const version = `${packageName}: v${packageVersion}`
 export const cdnBase = `${protocolHttp}://cdn.${domain}`
 export const endpointAuth = `${protocolHttp}://auth.${domain}/v1/users/session`
 export const endpointGraphQL = `${protocolHttp}://api.${domain}/v1/graphql`
+export const endpointRest = `${protocolHttp}://api.${domain}/v1`
 export const endpointWebsockets = `${protocolWebsockets}://api.${domain}/websockets`