@appsemble/types 0.36.10 → 0.37.1

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.36.10/config/assets/logo.svg) Appsemble Types
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.37.1/config/assets/logo.svg) Appsemble Types
 
 > Reusable TypeScript types
 
 [![npm](https://img.shields.io/npm/v/@appsemble/types)](https://www.npmjs.com/package/@appsemble/types)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.36.10/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.36.10)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.37.1/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.37.1)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -26,5 +26,5 @@ not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.36.10/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.37.1/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/index.d.ts

@@ -70,12 +70,26 @@ export interface BaseUserInfo {
     zoneinfo?: string;
 }
 export interface UserInfo extends BaseUserInfo {
+    /**
+     * External group values associated with the user.
+     */
+    groups?: string[];
     /**
      * If the user is subscribed to the newsletter
      */
     subscribed?: boolean;
     hasPassword?: boolean;
 }
+export interface AppLoginRoleMapping {
+    /**
+     * The exact external group value to match.
+     */
+    group: string;
+    /**
+     * The app role to assign when the group matches.
+     */
+    role: AppRole;
+}
 export interface SSOConfiguration {
     type: 'oauth2' | 'saml';
     url: string;
@@ -805,6 +819,10 @@ export interface AppOAuth2Secret extends OAuth2Provider {
      * The remapper to apply on the user info data.
      */
     remapper: Remapper;
+    /**
+     * Optional exact external-group to app-role mappings.
+     */
+    roleMappings?: AppLoginRoleMapping[];
 }
 export interface WritableAppSamlSecret {
     /**
@@ -832,9 +850,25 @@ export interface WritableAppSamlSecret {
      */
     nameAttribute: string;
     /**
-     * The custom SAML attribute that’s used to specify the user email address.
+     * The custom SAML attribute that's used to specify the user email address.
      */
     emailAttribute: string;
+    /**
+     * The custom SAML attribute that's used to specify whether the user's email address is verified.
+     */
+    emailVerifiedAttribute?: string;
+    /**
+     * The custom SAML attribute that contains the external groups for the user.
+     */
+    groupAttribute?: string;
+    /**
+     * The custom SAML attribute that's used to specify the external user identifier.
+     */
+    objectIdAttribute?: string;
+    /**
+     * Optional exact external-group to app-role mappings.
+     */
+    roleMappings?: AppLoginRoleMapping[];
 }
 export interface AppSamlSecret extends WritableAppSamlSecret {
     /**
@@ -850,7 +884,7 @@ export interface AppSamlSecret extends WritableAppSamlSecret {
      */
     spCertificate?: string;
 }
-export type SAMLStatus = 'badsignature' | 'emailconflict' | 'invalidrelaystate' | 'invalidsecret' | 'invalidstatuscode' | 'invalidsubjectconfirmation' | 'missingnameid' | 'missingsubject';
+export type SAMLStatus = 'badsignature' | 'emailconflict' | 'invalidrelaystate' | 'invalidsecret' | 'invalidstatuscode' | 'invalidsubjectconfirmation' | 'missingnameid' | 'missingsubject' | 'noRoleMatch';
 export interface ProjectBuildConfig extends ProjectConfig {
     /**
      * The build output directory relative to the project directory.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/types",
-  "version": "0.36.10",
+  "version": "0.37.1",
   "description": "TypeScript definitions reused within Appsemble internally",
   "keywords": [
     "app",
@@ -40,7 +40,7 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/lang-sdk": "0.36.10",
+    "@appsemble/lang-sdk": "0.37.1",
     "@fortawesome/fontawesome-common-types": "^6.0.0",
     "react": "^18.0.0"
   }

package/resource.d.ts

@@ -34,6 +34,10 @@ export interface Resource {
      * The user who last updated the resource.
      */
     $editor?: ResourceAuthor;
+    /**
+     * The opaque version token of the resource.
+     */
+    $etag?: string;
     /**
      * The app group that this resource is scoped to.
      */