@aarthiklabs/credit-sdk 0.0.3 → 0.0.4-1

package/dist/components/layout/iframe.d.ts

@@ -1 +1,2 @@
-export declare function IFrame({ className }: React.ComponentProps<"iframe">): import("react/jsx-runtime").JSX.Element;
+import React from "react";
+export declare const IFrame: React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.IframeHTMLAttributes<HTMLIFrameElement>, HTMLIFrameElement>, "ref"> & React.RefAttributes<HTMLIFrameElement>>;

package/dist/components/layout/shell.d.ts

@@ -1,2 +1,2 @@
 import type { TypeOfShellProperties } from "./types";
-export declare function Shell({ triggerProperties, title, fullscreen, }: TypeOfShellProperties): import("react/jsx-runtime").JSX.Element;
+export declare function Shell({ tenantID, applicationID, bootstrapToken, borrowerProviderID, borrowerContactNumber, baseURL, labURL, onReady, onError, onAuthStateChange, getBootstrapToken, onBootstrapExpired, onSessionEnd, persistSession, journeySelectionStrategy, triggerProperties, title, fullscreen, }: TypeOfShellProperties): import("react/jsx-runtime").JSX.Element;

package/dist/components/layout/types.d.ts

@@ -1,4 +1,7 @@
-import type { JSX } from "react";
+import type { Dispatch, JSX, RefObject, SetStateAction } from "react";
+import type { TypeOfAwaitable, TypeOfSDKProvisionJourney } from "../../core/types";
+type TypeOfShellAuthState = "idle" | "exchanging" | "provisioning" | "selecting" | "ready" | "refreshing" | "error" | "awaiting-bootstrap";
+type TypeOfJourneySelectionStrategy = "latest-active" | "most-recent" | "first" | ((journeys: TypeOfSDKProvisionJourney[]) => TypeOfSDKProvisionJourney | undefined);
 type TypeOfShellTriggerProperties = {
     label: string;
     component?: never;
@@ -7,24 +10,49 @@ type TypeOfShellTriggerProperties = {
     component: JSX.Element;
 };
 type TypeOfShellProperties = {
-    triggerProperties: TypeOfShellTriggerProperties;
-    title: string;
+    tenantID: string;
+    applicationID: string;
+    bootstrapToken: string;
+    borrowerProviderID: string;
+    borrowerContactNumber: string;
+    baseURL?: string;
+    labURL?: string;
+    onReady?: () => void;
+    onError?: (error: unknown) => void;
+    onAuthStateChange?: (state: TypeOfShellAuthState) => void;
+    getBootstrapToken?: () => TypeOfAwaitable<string>;
+    onBootstrapExpired?: () => void;
+    onSessionEnd?: () => void;
+    persistSession?: boolean;
+    journeySelectionStrategy?: TypeOfJourneySelectionStrategy;
+    triggerProperties?: TypeOfShellTriggerProperties;
+    title?: string;
     fullscreen?: "all" | "mobile-only" | "desktop-only" | "none";
 };
-type TypeOfWithDialogProperties = Omit<TypeOfShellProperties, "fullscreen"> & {
+type TypeOfWithDialogProperties = {
     open: boolean;
-    setOpen: React.Dispatch<React.SetStateAction<boolean>>;
-    loading: boolean;
-    setLoading: React.Dispatch<React.SetStateAction<boolean>>;
+    setOpen: Dispatch<SetStateAction<boolean>>;
+    isLoading: boolean;
+    error: Error | null;
+    onRetry: () => void;
+    iframeURL: string;
+    iframeRef: RefObject<HTMLIFrameElement | null>;
     isFullScreen: boolean;
-    setIsFullScreen: React.Dispatch<React.SetStateAction<boolean>>;
+    setIsFullScreen: Dispatch<SetStateAction<boolean>>;
+    title: string;
+    triggerProperties: TypeOfShellTriggerProperties;
 };
-type TypeOfWithDrawerProperties = Omit<TypeOfShellProperties, "fullscreen"> & {
+type TypeOfWithDrawerProperties = {
     open: boolean;
-    setOpen: React.Dispatch<React.SetStateAction<boolean>>;
-    loading: boolean;
-    setLoading: React.Dispatch<React.SetStateAction<boolean>>;
+    setOpen: Dispatch<SetStateAction<boolean>>;
+    isLoading: boolean;
+    error: Error | null;
+    onRetry: () => void;
+    iframeURL: string;
+    iframeRef: RefObject<HTMLIFrameElement | null>;
     isFullScreen: boolean;
-    setIsFullScreen: React.Dispatch<React.SetStateAction<boolean>>;
+    setIsFullScreen: Dispatch<SetStateAction<boolean>>;
+    title: string;
+    triggerProperties: TypeOfShellTriggerProperties;
 };
-export type { TypeOfShellProperties, TypeOfShellTriggerProperties, TypeOfWithDialogProperties, TypeOfWithDrawerProperties, };
+export type { TypeOfJourneySelectionStrategy, TypeOfShellAuthState, TypeOfShellProperties, TypeOfShellTriggerProperties, TypeOfWithDialogProperties, TypeOfWithDrawerProperties, };

package/dist/components/layout/with-dialog.d.ts

@@ -1,2 +1,2 @@
 import type { TypeOfWithDialogProperties } from "./types";
-export declare function WithDialog({ open, setOpen, loading, setLoading, isFullScreen, setIsFullScreen, triggerProperties: { label: triggerLabel, component: triggerComponent, }, title, }: TypeOfWithDialogProperties): import("react/jsx-runtime").JSX.Element;
+export declare function WithDialog({ open, setOpen, isLoading, error, onRetry, iframeURL, iframeRef, isFullScreen, setIsFullScreen, triggerProperties: { label: triggerLabel, component: triggerComponent, }, title, }: TypeOfWithDialogProperties): import("react/jsx-runtime").JSX.Element;

package/dist/components/layout/with-drawer.d.ts

@@ -1,2 +1,2 @@
 import type { TypeOfWithDrawerProperties } from "./types";
-export declare function WithDrawer({ open, setOpen, loading, setLoading, isFullScreen, setIsFullScreen, triggerProperties: { label: triggerLabel, component: triggerComponent, }, title, }: TypeOfWithDrawerProperties): import("react/jsx-runtime").JSX.Element;
+export declare function WithDrawer({ open, setOpen, isLoading, error, onRetry, iframeURL, iframeRef, isFullScreen, setIsFullScreen, triggerProperties: { label: triggerLabel, component: triggerComponent, }, title, }: TypeOfWithDrawerProperties): import("react/jsx-runtime").JSX.Element;

package/dist/core/auth/index.d.ts

@@ -0,0 +1 @@
+export * from "./token-manager";

package/dist/core/auth/token-manager.d.ts

@@ -0,0 +1,51 @@
+import type { ILogger, TypeOfSDKAuthSession, TypeOfAwaitable, TypeOfFetchLike } from "../types";
+export type TypeOfBootstrapTokenProvider = string | (() => TypeOfAwaitable<string>);
+export interface ISDKTokenManagerOptions {
+    baseURL: string;
+    bootstrapToken: TypeOfBootstrapTokenProvider;
+    parentOrigin?: string;
+    fetch?: TypeOfFetchLike;
+    logger?: ILogger;
+    accessTokenLeewaySeconds?: number;
+    now?: () => number;
+}
+type TypeOfSDKTokenState = {
+    tokenType: string;
+    accessToken: string;
+    scope: string;
+    expiresIn: number;
+    accessTokenExpiresAt: number;
+    refreshToken: string;
+    refreshTokenExpiresAt: number;
+    sessionID: string;
+};
+export declare class SDKTokenManager {
+    private readonly client;
+    private readonly bootstrapTokenProvider;
+    private readonly parentOrigin?;
+    private readonly accessTokenLeewayMs;
+    private readonly now;
+    private readonly logger?;
+    private tokenState?;
+    private exchangePromise?;
+    private refreshPromise?;
+    constructor(options: ISDKTokenManagerOptions);
+    getState(): TypeOfSDKTokenState | null;
+    clear(): void;
+    getSession(): Promise<TypeOfSDKAuthSession>;
+    getAccessToken(): Promise<string>;
+    exchange(): Promise<TypeOfSDKTokenState>;
+    refresh(): Promise<TypeOfSDKTokenState>;
+    private ensureValidSession;
+    private resolveBootstrapProvider;
+    private performExchange;
+    private performRefresh;
+    private buildTokenStateFromExchange;
+    private buildTokenStateFromRefresh;
+    private parseExpiresAt;
+    private isAccessTokenExpiring;
+    private isRefreshTokenExpired;
+    private toAuthSession;
+    private requiresRebootstrap;
+}
+export {};

package/dist/core/errors/errors.d.ts

@@ -16,6 +16,15 @@ export declare class AarthikError extends Error {
 export declare class AarthikConfigurationError extends AarthikError {
     constructor(message: string, meta?: TypeOfErrorMeta);
 }
+export declare class AarthikAuthError extends AarthikError {
+    constructor(message: string, meta?: TypeOfErrorMeta);
+}
+export declare class AarthikRebootstrapRequiredError extends AarthikError {
+    constructor(message: string, options?: {
+        cause?: unknown;
+        meta?: TypeOfErrorMeta;
+    });
+}
 export declare class AarthikNetworkError extends AarthikError {
     constructor(message: string, cause?: unknown, meta?: TypeOfErrorMeta);
 }

package/dist/core/journey/index.d.ts

@@ -0,0 +1 @@
+export * from "./journey-manager";

package/dist/core/journey/journey-manager.d.ts

@@ -0,0 +1,39 @@
+import type { ILogger, TypeOfAwaitable, TypeOfFetchLike, TypeOfSDKJourney } from "../types";
+export interface ISDKJourneyManagerOptions {
+    baseURL: string;
+    getAccessToken: () => TypeOfAwaitable<string>;
+    fetch?: TypeOfFetchLike;
+    logger?: ILogger;
+}
+export type TypeOfSDKJourneySelectionInput = {
+    journeyID?: string;
+    journeyIDs?: string[];
+    metadata?: Record<string, unknown>;
+};
+export type TypeOfSDKJourneyState = {
+    journey?: TypeOfSDKJourney;
+    journeyID: string;
+    tokenType: string;
+    accessToken: string;
+    scope: string;
+    expiresIn: number;
+    created: boolean;
+};
+export declare class SDKJourneyManager {
+    private readonly client;
+    private readonly getAccessToken;
+    private state?;
+    private attachPromise?;
+    constructor(options: ISDKJourneyManagerOptions);
+    getState(): TypeOfSDKJourneyState | null;
+    clear(): void;
+    selectOrCreateJourney(input?: TypeOfSDKJourneySelectionInput): Promise<TypeOfSDKJourneyState>;
+    selectJourney(journeyID: string): Promise<TypeOfSDKJourneyState>;
+    createJourney(metadata?: Record<string, unknown>): Promise<TypeOfSDKJourneyState>;
+    private performSelectOrCreate;
+    private resolveJourneyID;
+    private performSelect;
+    private performCreate;
+    private toStateFromSelect;
+    private toStateFromCreate;
+}

package/dist/core/provisioning/borrower-provisioning-manager.d.ts

@@ -0,0 +1,33 @@
+import type { ILogger, TypeOfAwaitable, TypeOfFetchLike, TypeOfSDKProvisionBorrower, TypeOfSDKProvisionJourney } from "../types";
+export interface ISDKBorrowerProvisioningManagerOptions {
+    baseURL: string;
+    getAccessToken: () => TypeOfAwaitable<string>;
+    fetch?: TypeOfFetchLike;
+    logger?: ILogger;
+}
+export type TypeOfSDKBorrowerProvisioningInput = {
+    borrowerProviderID: string;
+    contactNumber: string;
+};
+export type TypeOfSDKBorrowerProvisioningState = {
+    borrower: TypeOfSDKProvisionBorrower;
+    borrowerID: string;
+    journeys: TypeOfSDKProvisionJourney[];
+    journeyIDs: string[];
+    attached: boolean;
+    accessToken: string;
+    scope: string;
+    expiresIn: number;
+};
+export declare class SDKBorrowerProvisioningManager {
+    private readonly client;
+    private readonly getAccessToken;
+    private state?;
+    private provisionPromise?;
+    constructor(options: ISDKBorrowerProvisioningManagerOptions);
+    getState(): TypeOfSDKBorrowerProvisioningState | null;
+    clear(): void;
+    provisionBorrower(input: TypeOfSDKBorrowerProvisioningInput): Promise<TypeOfSDKBorrowerProvisioningState>;
+    private performProvision;
+    private toProvisioningState;
+}

package/dist/core/provisioning/index.d.ts

@@ -0,0 +1 @@
+export * from "./borrower-provisioning-manager";

package/dist/core/types/auth.d.ts

@@ -0,0 +1,33 @@
+export interface TypeOfAuthExchangeRequest {
+    bootstrap_token: string;
+    parent_origin?: string;
+}
+export interface TypeOfAuthExchangeResponse {
+    token_type: string;
+    access_token: string;
+    scope: string;
+    expires_in: number;
+    refresh_token: string;
+    refresh_expires_at: string;
+    session_id: string;
+}
+export interface TypeOfAuthRefreshRequest {
+    refresh_token: string;
+}
+export interface TypeOfAuthRefreshResponse {
+    token_type: string;
+    access_token: string;
+    scope: string;
+    expires_in: number;
+    refresh_token: string;
+    refresh_expires_at: string;
+}
+export interface TypeOfSDKAuthSession {
+    tokenType: string;
+    accessToken: string;
+    scope: string;
+    expiresIn: number;
+    sessionID: string;
+    accessTokenExpiresAt: number;
+    refreshTokenExpiresAt: number;
+}

package/dist/core/types/errors.d.ts

@@ -1,2 +1,2 @@
-export type TypeOfErrorCode = "CONFIG_ERROR" | "NETWORK_ERROR" | "TIMEOUT" | "ABORTED" | "HTTP_ERROR" | "PARSE_ERROR" | "UNKNOWN_ERROR";
+export type TypeOfErrorCode = "CONFIG_ERROR" | "AUTH_ERROR" | "AUTH_REQUIRES_BOOTSTRAP" | "NETWORK_ERROR" | "TIMEOUT" | "ABORTED" | "HTTP_ERROR" | "PARSE_ERROR" | "UNKNOWN_ERROR";
 export type TypeOfErrorMeta = Readonly<Record<string, unknown>>;

package/dist/core/types/index.d.ts

@@ -2,3 +2,6 @@ export * from "./utilities";
 export * from "./errors";
 export * from "./client";
 export * from "./http";
+export * from "./auth";
+export * from "./provisioning";
+export * from "./journey";

package/dist/core/types/journey.d.ts

@@ -0,0 +1,22 @@
+export interface TypeOfSDKJourneySelectRequest {
+    journey_id: string;
+}
+export interface TypeOfSDKJourneySelectResponse {
+    token_type: string;
+    access_token: string;
+    scope: string;
+    expires_in: number;
+}
+export interface TypeOfSDKJourneyCreateRequest {
+    metadata?: Record<string, unknown>;
+}
+export type TypeOfSDKJourney = Record<string, unknown> & {
+    journey_id?: string;
+};
+export interface TypeOfSDKJourneyCreateResponse {
+    journey: TypeOfSDKJourney;
+    token_type: string;
+    access_token: string;
+    scope: string;
+    expires_in: number;
+}

package/dist/core/types/provisioning.d.ts

@@ -0,0 +1,18 @@
+export interface TypeOfSDKProvisionRequest {
+    borrower_provider_id: string;
+    contact_number: string;
+}
+export type TypeOfSDKProvisionBorrower = Record<string, unknown> & {
+    borrower_id?: string;
+};
+export type TypeOfSDKProvisionJourney = Record<string, unknown> & {
+    journey_id?: string;
+};
+export interface TypeOfSDKProvisionResponse {
+    borrower: TypeOfSDKProvisionBorrower;
+    journeys: TypeOfSDKProvisionJourney[];
+    attached: boolean;
+    access_token: string;
+    scope: string;
+    expires_in: number;
+}