@evoke-platform/context 1.3.0-testing.4 → 1.3.0-testing.6

package/README.md

@@ -17,6 +17,7 @@ available and no further installation is necessary.
 
 -   [Working With Objects](#working-with-objects)
 -   [REST API Calls](#rest-api-calls)
+-   [Authentication Context](#authentication-context)
 -   [Notifications](#notifications)
 
 ### Working With Objects
@@ -222,6 +223,25 @@ absolute URL.
 
 ##### `delete(url, options)`
 
+### Authentication Context
+
+-   [useAuthenticationContext](#useauthenticationcontext)
+
+#### `useAuthenticationContext()`
+
+Hook to obtain the authentication context based on the current logged-in user.
+
+The authentication context includes the following property and functions.
+
+-   `account` _[object]_
+    -   The account of the currently logged-in user. This includes both the user's `id` and `name`.
+-   `logout()`
+    -   A function that logs out the currently logged-in user. The user will be redirected to Evoke's logout page upon logout.
+-   `getAccessToken()`
+    -   A function that returns an access token that is associated to the currently logged-in user. This token can be used to make API calls to Evoke's APIs to authenticate the API call.
+    -   Note: As a general recommendation, the [ApiService](#class-apiservices) class should be used to make API calls as it will take care
+        of appending an access token to the call.
+
 ### Notifications
 
 -   [useNofitication](#usenotification)

package/dist/authentication/AuthenticationContextProvider.d.ts

@@ -9,9 +9,12 @@ export type AuthenticationContext = {
 export type UserAccount = {
     id: string;
     name?: string;
+    username?: string;
+    lastLoginTime?: number;
+    activeMfaSession?: boolean;
 };
 export type AuthenticationContextProviderProps = {
-    msal: IMsalContext;
+    msal?: IMsalContext;
     authRequest: AuthenticationRequest;
     children?: ReactNode;
 };

package/dist/authentication/AuthenticationContextProvider.js

@@ -9,11 +9,25 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { jsx as _jsx } from "react/jsx-runtime";
 import { createContext, useCallback, useContext, useMemo } from 'react';
+import { useAuth } from 'react-oidc-context';
 const Context = createContext(undefined);
 Context.displayName = 'AuthenticationContext';
 function AuthenticationContextProvider(props) {
+    // Auto-detect provider type based on presence of msal prop
+    if (props.msal) {
+        const { msal, authRequest, children } = props;
+        return (_jsx(MsalProvider, { msal: msal, authRequest: authRequest, children: children }));
+    }
+    else {
+        const { authRequest, children } = props;
+        return _jsx(OidcProvider, { authRequest: authRequest, children: children });
+    }
+}
+function MsalProvider({ msal, authRequest, children }) {
     var _a;
-    const { msal, authRequest, children } = props;
+    if (!msal) {
+        throw new Error('MSAL instance is required for MsalProvider');
+    }
     const account = (_a = msal.instance.getActiveAccount()) !== null && _a !== void 0 ? _a : msal.instance.getAllAccounts()[0];
     const getAccessToken = useCallback(function () {
         return __awaiter(this, void 0, void 0, function* () {
@@ -26,19 +40,89 @@ function AuthenticationContextProvider(props) {
                 return '';
             }
         });
-    }, [msal, authRequest]);
-    const context = useMemo(() => account
-        ? {
-            account: { id: account.localAccountId, name: account.name },
-            logout: () => {
-                msal.instance.logoutRedirect({
-                    account,
-                    postLogoutRedirectUri: `/logout?p=${encodeURIComponent(window.location.pathname + window.location.search)}`,
-                });
-            },
-            getAccessToken,
-        }
-        : undefined, [account, msal, getAccessToken]);
+    }, [msal, authRequest, account]);
+    const context = useMemo(() => {
+        var _a, _b;
+        return account
+            ? {
+                account: {
+                    id: account.localAccountId,
+                    name: account.name,
+                    username: account.username,
+                    lastLoginTime: (_a = account.idTokenClaims) === null || _a === void 0 ? void 0 : _a.last_login_time,
+                    activeMfaSession: Boolean((_b = account.idTokenClaims) === null || _b === void 0 ? void 0 : _b.active_mfa_session),
+                },
+                logout: () => {
+                    msal.instance.logoutRedirect({
+                        account,
+                        postLogoutRedirectUri: `/logout?p=${encodeURIComponent(window.location.pathname + window.location.search)}`,
+                    });
+                },
+                getAccessToken,
+            }
+            : undefined;
+    }, [account, msal, getAccessToken, authRequest]);
+    return _jsx(Context.Provider, { value: context, children: children });
+}
+function OidcProvider({ authRequest, children }) {
+    var _a, _b;
+    // The authRequest for react-oidc is formatted slightly differently than msal.
+    const oidcAuthRequest = {
+        scope: (_b = (_a = authRequest.scopes) === null || _a === void 0 ? void 0 : _a.join(' ')) !== null && _b !== void 0 ? _b : 'openid profile email',
+        extraQueryParams: authRequest.extraQueryParameters,
+        state: authRequest.state,
+    };
+    const auth = useAuth();
+    const getAccessToken = useCallback(function () {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                // With automaticSilentRenew: true, oidc-client-ts will attempt to renew the token in the background before it expires.
+                // However, this is not guaranteed to be perfectly in sync with your API calls. Always check for expiration here and call signinSilent if needed
+                // to ensure you get a valid token on demand.
+                if (((_a = auth.user) === null || _a === void 0 ? void 0 : _a.access_token) && !auth.user.expired) {
+                    return auth.user.access_token;
+                }
+                // Token is either missing or expired - attempt silent refresh.
+                const user = yield auth.signinSilent(oidcAuthRequest);
+                // If signinSilent returns null, it means silent login failed
+                if (!user) {
+                    console.log('Silent login failed, redirecting to login');
+                    auth.signinRedirect(oidcAuthRequest);
+                    return '';
+                }
+                return ((_b = auth.user) === null || _b === void 0 ? void 0 : _b.access_token) || '';
+            }
+            catch (error) {
+                console.error('Failed to get access token:', error);
+                // If silent refresh throws an error (e.g., network failure, missing silent_redirect_uri,
+                // invalid session, refresh token expired, or provider returned an error), redirect to login
+                auth.signinRedirect(oidcAuthRequest);
+                return '';
+            }
+        });
+    }, [auth, authRequest]);
+    const context = useMemo(() => {
+        var _a, _b, _c, _d;
+        return auth.isAuthenticated && auth.user
+            ? {
+                account: {
+                    id: auth.user.profile.sub,
+                    name: (_a = auth.user.profile.name) !== null && _a !== void 0 ? _a : (`${(_b = auth.user.profile.given_name) !== null && _b !== void 0 ? _b : ''} ${(_c = auth.user.profile.family_name) !== null && _c !== void 0 ? _c : ''}` ||
+                        undefined),
+                    username: (_d = auth.user.profile.preferred_username) !== null && _d !== void 0 ? _d : auth.user.profile.email,
+                    lastLoginTime: auth.user.profile.lastLoginTime,
+                },
+                logout: () => {
+                    auth.signoutRedirect({
+                        // Fusion auth requires an absolute url.
+                        post_logout_redirect_uri: `${window.location.origin}/logout?p=${encodeURIComponent(window.location.pathname + window.location.search)}`,
+                    });
+                },
+                getAccessToken,
+            }
+            : undefined;
+    }, [auth, getAccessToken]);
     return _jsx(Context.Provider, { value: context, children: children });
 }
 export function useAuthenticationContext() {

package/dist/objects/objects.d.ts

@@ -29,20 +29,20 @@ type ViewLayoutEntity = {
 export type TableViewLayoutEntity = ViewLayoutEntity & TableViewLayout;
 export type DropdownViewLayoutEntity = ViewLayoutEntity & DropdownViewLayout;
 export type ViewLayout = {
-    table?: TableViewLayout;
-    dropdown?: DropdownViewLayout;
+    table?: TableViewLayout | null;
+    dropdown?: DropdownViewLayout | null;
 };
 export type DropdownViewLayoutSort = {
     propertyId: string;
-    direction?: 'asc' | 'desc';
+    direction?: 'asc' | 'desc' | null;
 };
 export type DropdownViewLayout = {
     secondaryTextExpression: string;
-    sort?: DropdownViewLayoutSort;
+    sort?: DropdownViewLayoutSort | null;
 };
 export type TableViewLayout = {
     properties: PropertyReference[];
-    sort?: Sort;
+    sort?: Sort | null;
 };
 export type PropertyReference = {
     id: string;
@@ -50,94 +50,94 @@ export type PropertyReference = {
 };
 export type Sort = {
     colId: string;
-    sort?: 'asc' | 'desc';
+    sort?: 'asc' | 'desc' | null;
 };
 export type Obj = {
     id: string;
     name: string;
-    typeDiscriminatorProperty?: string;
-    viewLayout?: ViewLayout;
-    baseObject?: BaseObjReference;
-    properties?: Property[];
-    actions?: Action[];
-    formId?: string;
+    typeDiscriminatorProperty?: string | null;
+    viewLayout?: ViewLayout | null;
+    baseObject?: BaseObjReference | null;
+    properties?: Property[] | null;
+    actions?: Action[] | null;
+    formId?: string | null;
 };
 export type ObjWithRoot = Obj & {
     rootObjectId: string;
 };
 export type PropertyType = 'address' | 'array' | 'boolean' | 'collection' | 'criteria' | 'date' | 'date-time' | 'document' | 'image' | 'integer' | 'number' | 'object' | 'richText' | 'string' | 'time' | 'user';
 export type NumericValidation = {
-    errorMessage?: string;
-    minimum?: number;
-    maximum?: number;
+    errorMessage?: string | null;
+    minimum?: number | null;
+    maximum?: number | null;
 };
 export type DateValidation = {
-    errorMessage?: string;
-    to?: string;
-    from?: string;
+    errorMessage?: string | null;
+    to?: string | null;
+    from?: string | null;
 };
 export type CriteriaValidation = {
-    criteria?: Record<string, unknown>;
+    criteria?: Record<string, unknown> | null;
 };
 export type StringValidation = {
     operator: 'any' | 'all';
-    rules?: RegexValidation[];
+    rules?: RegexValidation[] | null;
 };
 export type DocumentValidation = {
-    errorMessage?: string;
-    maxDocuments?: number;
-    minDocuments?: number;
+    errorMessage?: string | null;
+    maxDocuments?: number | null;
+    minDocuments?: number | null;
 };
 export type PropertyValidation = StringValidation | NumericValidation | DateValidation | CriteriaValidation | DocumentValidation;
 export type Property = {
     id: string;
     name: string;
     type: PropertyType;
-    enum?: string[];
-    strictlyTrue?: boolean;
-    nonStrictEnum?: boolean;
-    objectId?: string;
-    relatedPropertyId?: string;
-    required?: boolean;
-    searchable?: boolean;
-    formula?: string;
-    formulaType?: 'aggregate' | 'custom' | 'arithmetic';
-    mask?: string;
-    validation?: PropertyValidation;
-    manyToManyPropertyId?: string;
-    textTransform?: 'titleCase' | 'upperCase' | 'lowerCase' | 'sentenceCase';
+    enum?: string[] | null;
+    strictlyTrue?: boolean | null;
+    nonStrictEnum?: boolean | null;
+    objectId?: string | null;
+    relatedPropertyId?: string | null;
+    required?: boolean | null;
+    searchable?: boolean | null;
+    formula?: string | null;
+    formulaType?: 'aggregate' | 'custom' | 'arithmetic' | null;
+    mask?: string | null;
+    validation?: PropertyValidation | null;
+    manyToManyPropertyId?: string | null;
+    textTransform?: 'titleCase' | 'upperCase' | 'lowerCase' | 'sentenceCase' | null;
 };
 export type ActionType = 'create' | 'update' | 'delete';
 export type InputStringValidation = StringValidation & {
-    minLength?: number;
-    maxLength?: number;
-    mask?: string;
+    minLength?: number | null;
+    maxLength?: number | null;
+    mask?: string | null;
 };
 export type BasicInputParameter = Omit<InputParameter, 'name' | 'required'>;
 export type InputParameter = {
     id: string;
-    name?: string;
+    name?: string | null;
     type: PropertyType;
-    required?: boolean;
-    enum?: string[];
-    strictlyTrue?: boolean;
-    nonStrictEnum?: boolean;
-    validation?: PropertyValidation | InputStringValidation;
-    objectId?: string;
-    relatedPropertyId?: string;
-    manyToManyPropertyId?: string;
+    required?: boolean | null;
+    enum?: string[] | null;
+    strictlyTrue?: boolean | null;
+    nonStrictEnum?: boolean | null;
+    validation?: PropertyValidation | InputStringValidation | null;
+    objectId?: string | null;
+    relatedPropertyId?: string | null;
+    manyToManyPropertyId?: string | null;
 };
 export type Action = {
     id: string;
     name: string;
     type: ActionType;
     outputEvent: string;
-    inputProperties?: ActionInput[];
-    parameters?: InputParameter[];
-    form?: Form;
-    defaultFormId?: string;
-    customCode?: string;
-    preconditions?: object;
+    inputProperties?: ActionInput[] | null;
+    parameters?: InputParameter[] | null;
+    form?: Form | null;
+    defaultFormId?: string | null;
+    customCode?: string | null;
+    preconditions?: object | null;
 };
 export type ObjectInstance = {
     id: string;
@@ -147,7 +147,7 @@ export type ObjectInstance = {
 };
 export type RegexValidation = {
     regex: string;
-    errorMessage?: string;
+    errorMessage?: string | null;
 };
 export type SelectOption = {
     label: string;
@@ -157,170 +157,170 @@ export type VisibilityCondition = {
     property: string;
     operator: 'eq' | 'ne';
     value: string | number | boolean;
-    isInstanceProperty?: boolean;
+    isInstanceProperty?: boolean | null;
 };
 export type VisibilityConfiguration = {
-    operator?: 'any' | 'all';
-    conditions?: VisibilityCondition[];
+    operator?: 'any' | 'all' | null;
+    conditions?: VisibilityCondition[] | null;
 };
 export type RelatedObjectDefaultValue = {
     criteria: Record<string, unknown>;
-    sortBy?: string;
-    orderBy?: 'asc' | 'desc' | 'ASC' | 'DESC';
+    sortBy?: string | null;
+    orderBy?: 'asc' | 'desc' | 'ASC' | 'DESC' | null;
 };
 export type CriteriaDefaultValue = Record<string, unknown>;
 export type JsonLogic = Record<string, unknown> | boolean | number | string | null;
 export type DisplayConfiguration = {
-    label?: string;
-    placeholder?: string;
-    required?: boolean;
-    description?: string;
-    defaultValue?: string | boolean | number | string[] | RelatedObjectDefaultValue | CriteriaDefaultValue;
-    readOnly?: boolean;
-    tooltip?: string;
-    prefix?: string;
-    suffix?: string;
-    placeholderChar?: string;
-    rowCount?: number;
-    charCount?: boolean;
-    mode?: 'default' | 'existingOnly';
-    relatedObjectDisplay?: 'dropdown' | 'dialogBox';
-    visibility?: VisibilityConfiguration | JsonLogic;
-    viewLayout?: ViewLayoutEntityReference;
+    label?: string | null;
+    placeholder?: string | null;
+    required?: boolean | null;
+    description?: string | null;
+    defaultValue?: string | boolean | number | string[] | RelatedObjectDefaultValue | CriteriaDefaultValue | null;
+    readOnly?: boolean | null;
+    tooltip?: string | null;
+    prefix?: string | null;
+    suffix?: string | null;
+    placeholderChar?: string | null;
+    rowCount?: number | null;
+    charCount?: boolean | null;
+    mode?: 'default' | 'existingOnly' | null;
+    relatedObjectDisplay?: 'dropdown' | 'dialogBox' | null;
+    visibility?: VisibilityConfiguration | JsonLogic | null;
+    viewLayout?: ViewLayoutEntityReference | null;
     choicesDisplay?: {
         type: 'dropdown' | 'radioButton';
-        sortBy?: 'ASC' | 'DESC' | 'NONE';
-    };
-    booleanDisplay?: 'checkbox' | 'switch';
+        sortBy?: 'ASC' | 'DESC' | 'NONE' | null;
+    } | null;
+    booleanDisplay?: 'checkbox' | 'switch' | null;
 };
 export type InputParameterReference = {
     type: 'input';
     parameterId: string;
-    display?: DisplayConfiguration;
-    enumWithLabels?: SelectOption[];
-    documentMetadata?: Record<string, string>;
+    display?: DisplayConfiguration | null;
+    enumWithLabels?: SelectOption[] | null;
+    documentMetadata?: Record<string, string> | null;
 };
 export type Content = {
     type: 'content';
     html: string;
-    visibility?: VisibilityConfiguration | JsonLogic;
+    visibility?: VisibilityConfiguration | JsonLogic | null;
 };
 export type Column = {
     width: number;
-    entries?: FormEntry[];
+    entries?: FormEntry[] | null;
 };
 export type Columns = {
     type: 'columns';
     columns: Column[];
-    visibility?: VisibilityConfiguration | JsonLogic;
+    visibility?: VisibilityConfiguration | JsonLogic | null;
 };
 export type Section = {
     label: string;
-    entries?: FormEntry[];
+    entries?: FormEntry[] | null;
 };
 export type Sections = {
     type: 'sections';
-    label?: string;
+    label?: string | null;
     sections: Section[];
-    visibility?: VisibilityConfiguration | JsonLogic;
+    visibility?: VisibilityConfiguration | JsonLogic | null;
 };
 export type ReadonlyField = {
     type: 'readonlyField';
     propertyId: string;
-    display?: DisplayConfiguration;
+    display?: DisplayConfiguration | null;
 };
 export type InputField = {
     type: 'inputField';
     input: BasicInputParameter;
-    display?: DisplayConfiguration;
-    documentMetadata?: Record<string, string>;
+    display?: DisplayConfiguration | null;
+    documentMetadata?: Record<string, string> | null;
 };
 export type FormEntry = InputField | InputParameterReference | ReadonlyField | Sections | Columns | Content;
 export type Form = {
-    entries?: FormEntry[];
+    entries?: FormEntry[] | null;
 };
 export type ActionInputType = 'button' | 'Boolean' | 'Columns' | 'Content' | 'Criteria' | 'Date' | 'DateTime' | 'Decimal' | 'Document' | 'Image' | 'Integer' | 'ManyToManyRepeatableField' | 'MultiSelect' | 'Object' | 'RepeatableField' | 'RichText' | 'Section' | 'Select' | 'TextField' | 'Time' | 'User';
 /**
  * Represents an object action inputProperty object.
  */
 export type ActionInput = {
-    id?: string;
-    label?: string;
-    type?: ActionInputType;
-    key?: string;
-    initialValue?: boolean | string | string[] | number | RelatedObjectDefaultValue | SelectOption[] | SelectOption;
-    defaultToCurrentDate?: boolean;
-    defaultToCurrentTime?: boolean;
-    defaultValueCriteria?: object;
-    sortBy?: string;
-    orderBy?: 'asc' | 'desc' | 'ASC' | 'DESC';
-    html?: string;
-    labelPosition?: string;
-    placeholder?: string;
-    description?: string;
-    tooltip?: string;
-    prefix?: string;
-    suffix?: string;
+    id?: string | null;
+    label?: string | null;
+    type?: ActionInputType | null;
+    key?: string | null;
+    initialValue?: boolean | string | string[] | number | RelatedObjectDefaultValue | SelectOption[] | SelectOption | null;
+    defaultToCurrentDate?: boolean | null;
+    defaultToCurrentTime?: boolean | null;
+    defaultValueCriteria?: object | null;
+    sortBy?: string | null;
+    orderBy?: 'asc' | 'desc' | 'ASC' | 'DESC' | null;
+    html?: string | null;
+    labelPosition?: string | null;
+    placeholder?: string | null;
+    description?: string | null;
+    tooltip?: string | null;
+    prefix?: string | null;
+    suffix?: string | null;
     data?: {
         /**
          * An array of values required for select options.
          */
-        values?: SelectOption[];
-    };
-    inputMask?: string;
-    inputMaskPlaceholderChar?: string;
-    tableView?: boolean;
-    mode?: 'default' | 'existingOnly';
-    displayOption?: 'dropdown' | 'dialogBox' | 'radioButton' | 'checkbox' | 'switch';
-    rows?: number;
-    showCharCount?: boolean;
-    readOnly?: boolean;
-    isMultiLineText?: boolean;
-    verticalLayout?: boolean;
-    input?: boolean;
-    widget?: string;
+        values?: SelectOption[] | null;
+    } | null;
+    inputMask?: string | null;
+    inputMaskPlaceholderChar?: string | null;
+    tableView?: boolean | null;
+    mode?: 'default' | 'existingOnly' | null;
+    displayOption?: 'dropdown' | 'dialogBox' | 'radioButton' | 'checkbox' | 'switch' | null;
+    rows?: number | null;
+    showCharCount?: boolean | null;
+    readOnly?: boolean | null;
+    isMultiLineText?: boolean | null;
+    verticalLayout?: boolean | null;
+    input?: boolean | null;
+    widget?: string | null;
     conditional?: {
-        json?: JsonLogic;
-        show?: boolean;
-        when?: string;
-        eq?: string | number | boolean;
-    };
-    property?: InputParameter;
-    viewLayout?: ViewLayoutEntityReference;
-    documentMetadata?: Record<string, string>;
+        json?: JsonLogic | null;
+        show?: boolean | null;
+        when?: string | null;
+        eq?: string | number | boolean | null;
+    } | null;
+    property?: InputParameter | null;
+    viewLayout?: ViewLayoutEntityReference | null;
+    documentMetadata?: Record<string, string> | null;
     validate?: {
-        required?: boolean;
-        criteria?: object;
-        operator?: 'any' | 'all';
-        regexes?: RegexValidation[];
-        minLength?: number;
-        maxLength?: number;
-        minDate?: string;
-        maxDate?: string;
-        minTime?: string;
-        maxTime?: string;
-        min?: number;
-        max?: number;
-        minDocuments?: number;
-        maxDocuments?: number;
-        customMessage?: string;
+        required?: boolean | null;
+        criteria?: object | null;
+        operator?: 'any' | 'all' | null;
+        regexes?: RegexValidation[] | null;
+        minLength?: number | null;
+        maxLength?: number | null;
+        minDate?: string | null;
+        maxDate?: string | null;
+        minTime?: string | null;
+        maxTime?: string | null;
+        min?: number | null;
+        max?: number | null;
+        minDocuments?: number | null;
+        maxDocuments?: number | null;
+        customMessage?: string | null;
     };
     /**
      * An array of sub-components to be rendered inside sections.
      */
     components?: {
         key: string;
-        label?: string;
+        label?: string | null;
         components: ActionInput[];
-    }[];
+    }[] | null;
     /**
      * An array of sub-components to be rendered inside columns.
      */
     columns?: {
         width: number;
-        currentWidth?: number;
+        currentWidth?: number | null;
         components: ActionInput[];
-    }[];
+    }[] | null;
 };
 export type ActionRequest = {
     actionId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@evoke-platform/context",
-    "version": "1.3.0-testing.4",
+    "version": "1.3.0-testing.6",
     "description": "Utilities that provide context to Evoke platform widgets",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -56,6 +56,7 @@
         "msw": "^1.3.1",
         "react": "^18.2.0",
         "react-dom": "^18.3.1",
+        "react-oidc-context": "^2.4.0",
         "react-router-dom": "^6.16.0",
         "sinon": "^18.0.0",
         "typescript": "^5.3.3"
@@ -64,12 +65,14 @@
         "@azure/msal-browser": ">=2",
         "@azure/msal-react": ">=1",
         "react": ">=18",
+        "react-oidc-context": ">=2",
         "react-router-dom": ">=6"
     },
     "dependencies": {
         "@isaacs/ttlcache": "^1.4.1",
         "@microsoft/signalr": "^7.0.12",
         "axios": "^1.7.9",
+        "oidc-client-ts": "^3.3.0",
         "uuid": "^9.0.1"
     }
 }