@evoke-platform/context 1.0.1-dev.0 → 1.1.0-testing.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -20
- package/dist/objects/objects.d.ts +2 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,7 +17,6 @@ available and no further installation is necessary.
|
|
|
17
17
|
|
|
18
18
|
- [Working With Objects](#working-with-objects)
|
|
19
19
|
- [REST API Calls](#rest-api-calls)
|
|
20
|
-
- [Authentication Context](#authentication-context)
|
|
21
20
|
- [Notifications](#notifications)
|
|
22
21
|
|
|
23
22
|
### Working With Objects
|
|
@@ -207,25 +206,6 @@ absolute URL.
|
|
|
207
206
|
|
|
208
207
|
##### `delete(url, options)`
|
|
209
208
|
|
|
210
|
-
### Authentication Context
|
|
211
|
-
|
|
212
|
-
- [useAuthenticationContext](#useauthenticationcontext)
|
|
213
|
-
|
|
214
|
-
#### `useAuthenticationContext()`
|
|
215
|
-
|
|
216
|
-
Hook to obtain the authentication context based on the current logged-in user.
|
|
217
|
-
|
|
218
|
-
The authentication context includes the following property and functions.
|
|
219
|
-
|
|
220
|
-
- `account` _[object]_
|
|
221
|
-
- The account of the currently logged-in user. This includes both the user's `id` and `name`.
|
|
222
|
-
- `logout()`
|
|
223
|
-
- A function that logs out the currently logged-in user. The user will be redirected to Evoke's logout page upon logout.
|
|
224
|
-
- `getAccessToken()`
|
|
225
|
-
- 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.
|
|
226
|
-
- Note: As a general recommendation, the [ApiService](#class-apiservices) class should be used to make API calls as it will take care
|
|
227
|
-
of appending an access token to the call.
|
|
228
|
-
|
|
229
209
|
### Notifications
|
|
230
210
|
|
|
231
211
|
- [useNofitication](#usenotification)
|
|
@@ -146,12 +146,13 @@ export type RelatedObjectDefaultValue = {
|
|
|
146
146
|
sortBy?: string;
|
|
147
147
|
orderBy?: 'asc' | 'desc' | 'ASC' | 'DESC';
|
|
148
148
|
};
|
|
149
|
+
export type CriteriaDefaultValue = Record<string, unknown>;
|
|
149
150
|
export type DisplayConfiguration = {
|
|
150
151
|
label?: string;
|
|
151
152
|
placeholder?: string;
|
|
152
153
|
required?: boolean;
|
|
153
154
|
description?: string;
|
|
154
|
-
defaultValue?: string | number | string[] | RelatedObjectDefaultValue;
|
|
155
|
+
defaultValue?: string | number | string[] | RelatedObjectDefaultValue | CriteriaDefaultValue;
|
|
155
156
|
readOnly?: boolean;
|
|
156
157
|
tooltip?: string;
|
|
157
158
|
prefix?: string;
|