@laserfiche/types-lf-ui-components 14.1.3 → 14.1.4--preview-5405249657

package/index.d.ts

@@ -141,6 +141,14 @@ declare interface FieldValues {
     [fieldId: number]: FieldValue;
 }
 
+/**
+ * Interface defined by Laserfiche API providing
+ * return type of beforeFetchRequestAsync
+ */
+export declare interface LfBeforeFetchResult {
+    regionalDomain: string;
+}
+
 export declare interface LfBreadcrumb {
     name: string;
     id: string;
@@ -501,6 +509,27 @@ export declare interface LfFieldTemplateProviders {
 
 declare type LfFieldValue = string;
 
+/**
+ * This object handles obtaining the accessToken and
+ * setting the authorization header
+ */
+export declare interface LfHttpRequestHandler {
+    /**
+     * Called to prepare the request to the API service.
+     * @param url The HTTP url
+     * @param request The HTTP request
+     */
+    beforeFetchRequestAsync: (url: string, request: RequestInit) => Promise<LfBeforeFetchResult>;
+    /**
+     * Called to handle the response from the API service.
+     * @param url The HTTP url
+     * @param response The HTTP response
+     * @param request The HTTP request
+     * @returns true if the request should be retried.
+     */
+    afterFetchResponseAsync: (url: string, response: Response, request: RequestInit) => Promise<boolean>;
+}
+
 export declare class LfLoginComponent {
 
 
@@ -508,6 +537,12 @@ export declare class LfLoginComponent {
 
 
     mode: LoginMode;
+    /**
+     * @return {LfHttpRequestHandler}
+     * Returns the LfHttpRequestHandler that can be used
+     * to instantiate a repository API client.
+     */
+    get authorizationRequestHandler(): LfHttpRequestHandler;
 
 
 
@@ -538,6 +573,12 @@ export declare class LfLoginComponent {
     logoutInitiated: CustomEvent<string>;
     loginCompleted: CustomEvent<void>;
     logoutCompleted: CustomEvent<void | AbortedLoginError>;
+    /**
+     * Refreshes and returns the access token
+     * @param initiateLoginFlowOnRefreshFailure
+     * Indicates whether an attempt should be made to login using OAuth flow upon encountering an inability to refresh the access token.
+     * @returns  {Promise<string | undefined>}
+     */
     refreshTokenAsync: (initiateLoginFlowOnRefreshFailure: boolean) => Promise<string | undefined>;
     initLoginFlowAsync: () => Promise<string | undefined>;
     handleRedirectURICallbackAsync: (url: string) => Promise<void>;
@@ -567,6 +608,8 @@ export declare class LfLoginComponent {
 
 
 
+
+
 
 
 
@@ -745,7 +788,6 @@ export declare class LfRepositoryBrowserComponent {
 
 
 
-
 
 
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@laserfiche/types-lf-ui-components",
-  "version": "14.1.3",
+  "version": "14.1.4--preview-5405249657",
   "scripts": {},
   "dependencies": {},
   "devDependencies": {},