@evoke-platform/context 1.2.0 → 1.3.0-dev.2

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/objects/objects.d.ts

@@ -1,5 +1,8 @@
 import { ApiServices, Callback } from '../api/index.js';
 import { Filter } from './filters.js';
+export type EvokeFormDisplayConfiguration = {
+    submitLabel?: string;
+};
 export type EvokeForm = {
     id: string;
     name: string;
@@ -8,6 +11,7 @@ export type EvokeForm = {
     formObjectId?: string;
     actionId?: string;
     autosaveActionId?: string;
+    display?: EvokeFormDisplayConfiguration;
 };
 export type BaseObjReference = {
     objectId: string;
@@ -90,6 +94,7 @@ export type Property = {
     name: string;
     type: PropertyType;
     enum?: string[];
+    strictlyTrue?: boolean;
     nonStrictEnum?: boolean;
     objectId?: string;
     relatedPropertyId?: string;
@@ -114,6 +119,7 @@ export type InputParameter = {
     type: PropertyType;
     required?: boolean;
     enum?: string[];
+    strictlyTrue?: boolean;
     nonStrictEnum?: boolean;
     validation?: PropertyValidation | InputStringValidation;
     objectId?: string;

package/package.json

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