@evoke-platform/context 1.0.0-dev.126 → 1.0.0-dev.128

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
@@ -206,6 +207,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/objects/objects.d.ts

@@ -51,7 +51,7 @@ export type Obj = {
 export type ObjWithRoot = Obj & {
     rootObjectId: string;
 };
-export type PropertyType = 'address' | 'array' | 'boolean' | 'collection' | 'date' | 'date-time' | 'document' | 'image' | 'integer' | 'number' | 'object' | 'richText' | 'string' | 'time' | 'user';
+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;
@@ -202,7 +202,7 @@ export type FormEntry = InputParameterReference | Columns | Sections | Content;
 export type Form = {
     entries?: FormEntry[];
 };
-export type ActionInputType = 'button' | 'Section' | 'Columns' | 'Content' | 'Select' | 'TextField' | 'DateTime' | 'Document' | 'RepeatableField' | 'ManyToManyRepeatableField' | 'MultiSelect' | 'Decimal' | 'RichText' | 'Date' | 'Integer' | 'Image' | 'Object' | 'Time' | 'User';
+export type ActionInputType = 'button' | 'Section' | 'Columns' | 'Content' | 'Criteria' | 'Select' | 'TextField' | 'DateTime' | 'Document' | 'RepeatableField' | 'ManyToManyRepeatableField' | 'MultiSelect' | 'Decimal' | 'RichText' | 'Date' | 'Integer' | 'Image' | 'Object' | 'Time' | 'User';
 /**
  * Represents an object action inputProperty object.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@evoke-platform/context",
-    "version": "1.0.0-dev.126",
+    "version": "1.0.0-dev.128",
     "description": "Utilities that provide context to Evoke platform widgets",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",