@appsemble/types 0.24.8 → 0.24.10

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.
Files changed (3) hide show
  1. package/README.md +3 -3
  2. package/index.d.ts +18 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,9 +1,9 @@
1
- # ![](https://gitlab.com/appsemble/appsemble/-/raw/0.24.8/config/assets/logo.svg) Appsemble Types
1
+ # ![](https://gitlab.com/appsemble/appsemble/-/raw/0.24.10/config/assets/logo.svg) Appsemble Types
2
2
 
3
3
  > Reusable TypeScript types
4
4
 
5
5
  [![npm](https://img.shields.io/npm/v/@appsemble/types)](https://www.npmjs.com/package/@appsemble/types)
6
- [![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.24.8/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.24.8)
6
+ [![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.24.10/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.24.10)
7
7
  [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
8
8
 
9
9
  ## Table of Contents
@@ -26,5 +26,5 @@ not guaranteed.
26
26
 
27
27
  ## License
28
28
 
29
- [LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.24.8/LICENSE.md) ©
29
+ [LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.24.10/LICENSE.md) ©
30
30
  [Appsemble](https://appsemble.com)
package/index.d.ts CHANGED
@@ -155,6 +155,10 @@ export interface UserInfo {
155
155
  * If the user is subscribed to the newsletter
156
156
  */
157
157
  subscribed?: boolean;
158
+ /**
159
+ * The properties of the currently logged in member of the app
160
+ */
161
+ appMember?: AppMember;
158
162
  }
159
163
  /**
160
164
  * The payload stored in our JSON web tokens
@@ -245,6 +249,18 @@ export interface Remappers {
245
249
  * - `url`: Get the base URL of the app.
246
250
  */
247
251
  app: 'id' | 'locale' | 'url';
252
+ /**
253
+ * Get property of the AppMember object.
254
+ *
255
+ * Supported properties:
256
+ *
257
+ * - `memberId`: Get the id of the AppMember.
258
+ * - `userId`: Get the id of the user associated with AppMember object.
259
+ * - `role`: Get the role of the app member
260
+ * - `primaryEmail`: Get the primary email of the user associated with AppMember object.
261
+ * - `name`: Get the name of the user associated with AppMember object.
262
+ */
263
+ appMember: keyof AppMember;
248
264
  /**
249
265
  * Get page metadata.
250
266
  *
@@ -1742,7 +1758,8 @@ export interface OrganizationInvite {
1742
1758
  * App member in an app.
1743
1759
  */
1744
1760
  export interface AppMember {
1745
- id: string;
1761
+ userId: string;
1762
+ memberId: string;
1746
1763
  name: string;
1747
1764
  primaryEmail: string;
1748
1765
  role: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@appsemble/types",
3
- "version": "0.24.8",
3
+ "version": "0.24.10",
4
4
  "description": "TypeScript definitions reused within Appsemble internally",
5
5
  "keywords": [
6
6
  "app",