@appsemble/utils 0.36.10 → 0.37.0

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.36.10/config/assets/logo.svg) Appsemble Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.37.0/config/assets/logo.svg) Appsemble Utilities
 
 > Internal utility functions used across multiple Appsemble projects.
 
 [![npm](https://img.shields.io/npm/v/@appsemble/utils)](https://www.npmjs.com/package/@appsemble/utils)
-[![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.0/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.37.0)
 [![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.0/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/api/components/parameters/selectedGroupId.js

@@ -1,7 +1,11 @@
 export const selectedGroupId = {
     name: 'selectedGroupId',
     in: 'query',
-    description: 'The currently selected group of the app member.',
-    schema: { type: 'number' },
+    description: 'The selected groups of the app member to scope the request to. Accepts a single value ' +
+        '(`selectedGroupId=1`) or several (`selectedGroupId=1&selectedGroupId=2`). Pass -1 for the ' +
+        'app-wide scope.',
+    style: 'form',
+    explode: true,
+    schema: { type: 'array', items: { type: 'number' } },
 };
 //# sourceMappingURL=selectedGroupId.js.map

package/api/components/schemas/AppOAuth2Secret.js

@@ -49,6 +49,26 @@ export const AppOAuth2Secret = {
             description: 'A remapper to apply on retrieved user information from the user info endpoint.',
             items: {},
         },
+        roleMappings: {
+            type: 'array',
+            description: 'Optional exact external-group to app-role mappings.',
+            items: {
+                type: 'object',
+                description: 'A mapping from one exact external group value to one app role.',
+                required: ['group', 'role'],
+                additionalProperties: false,
+                properties: {
+                    group: {
+                        type: 'string',
+                        description: 'The exact external group value to match.',
+                    },
+                    role: {
+                        type: 'string',
+                        description: 'The app role to assign when the external group matches.',
+                    },
+                },
+            },
+        },
         created: {
             type: 'string',
             format: 'date-time',

package/api/components/schemas/AppSamlSecret.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const AppSamlSecret: OpenAPIV3.NonArraySchemaObject;

package/api/components/schemas/AppSamlSecret.js

@@ -0,0 +1,86 @@
+export const AppSamlSecret = {
+    type: 'object',
+    description: 'Settings for login in apps using third party SAML providers',
+    required: ['entityId', 'icon', 'idpCertificate', 'name', 'ssoUrl'],
+    additionalProperties: false,
+    properties: {
+        id: {
+            type: 'number',
+            description: 'An autogenerated ID.',
+            readOnly: true,
+        },
+        entityId: {
+            type: 'string',
+            format: 'uri',
+            description: 'The URL where the identity provider metadata is hosted.',
+        },
+        ssoUrl: {
+            type: 'string',
+            format: 'uri',
+            description: 'The URL where the user is redirected to log in.',
+        },
+        idpCertificate: {
+            type: 'string',
+            description: 'The certificate of the identity provider.',
+        },
+        icon: {
+            type: 'string',
+            description: 'A Font Awesome icon which represents the SAML provider.',
+        },
+        name: {
+            type: 'string',
+            description: 'A display name which represents the SAML provider.',
+        },
+        emailAttribute: {
+            type: 'string',
+            description: 'The SAML attribute that contains the user email address.',
+        },
+        emailVerifiedAttribute: {
+            type: 'string',
+            description: 'The SAML attribute that contains whether the email address is verified.',
+        },
+        nameAttribute: {
+            type: 'string',
+            description: 'The SAML attribute that contains the user display name.',
+        },
+        groupAttribute: {
+            type: 'string',
+            description: 'The SAML attribute that contains the external groups for the user.',
+        },
+        objectIdAttribute: {
+            type: 'string',
+            description: 'The SAML attribute that contains the external user identifier.',
+        },
+        roleMappings: {
+            type: 'array',
+            description: 'Optional exact external-group to app-role mappings.',
+            items: {
+                type: 'object',
+                description: 'A mapping from one exact external group value to one app role.',
+                required: ['group', 'role'],
+                additionalProperties: false,
+                properties: {
+                    group: {
+                        type: 'string',
+                        description: 'The exact external group value to match.',
+                    },
+                    role: {
+                        type: 'string',
+                        description: 'The app role to assign when the external group matches.',
+                    },
+                },
+            },
+        },
+        spCertificate: {
+            type: 'string',
+            description: 'The generated SAML service provider certificate.',
+            readOnly: true,
+        },
+        updated: {
+            type: 'string',
+            format: 'date-time',
+            description: 'When the secret was last updated.',
+        },
+    },
+};
+//# sourceMappingURL=AppSamlSecret.js.map

package/api/components/schemas/index.d.ts

@@ -5,6 +5,7 @@ export * from './AppMember.js';
 export * from './AppMemberInfo.js';
 export * from './AppMessages.js';
 export * from './AppOAuth2Secret.js';
+export * from './AppSamlSecret.js';
 export * from './AppsembleMessages.js';
 export * from './AppServiceSecret.js';
 export * from './AppVariable.js';

package/api/components/schemas/index.js

@@ -5,6 +5,7 @@ export * from './AppMember.js';
 export * from './AppMemberInfo.js';
 export * from './AppMessages.js';
 export * from './AppOAuth2Secret.js';
+export * from './AppSamlSecret.js';
 export * from './AppsembleMessages.js';
 export * from './AppServiceSecret.js';
 export * from './AppVariable.js';

package/api/paths/apps/appId/resources/resourceType/resourceId.js

@@ -1,3 +1,27 @@
+const resourceContent = {
+    'application/json': {
+        schema: { $ref: '#/components/schemas/Resource' },
+    },
+    'text/csv': {
+        schema: { type: 'string' },
+    },
+};
+const etagResponseHeader = {
+    ETag: {
+        description: 'Strong validator for the current version of the resource.',
+        schema: { type: 'string' },
+    },
+};
+const ifMatchParameter = {
+    name: 'If-Match',
+    in: 'header',
+    required: false,
+    description: 'Strong ETag from a prior response. The request only proceeds if the resource still matches; otherwise the server responds with 412 Precondition Failed.',
+    schema: { type: 'string' },
+};
+const preconditionFailedResponse = {
+    description: 'The `If-Match` header did not match the current ETag of the resource. The caller should fetch the latest version and retry.',
+};
 export const pathItems = {
     parameters: [
         { $ref: '#/components/parameters/appId' },
@@ -20,8 +44,9 @@ export const pathItems = {
         operationId: 'getAppResourceById',
         responses: {
             200: {
-                description: 'The resource that matches the given id.',
-                $ref: '#/components/responses/resource',
+                description: 'The resource that matches the given id. Omits the `ETag` header on view responses.',
+                content: resourceContent,
+                headers: etagResponseHeader,
             },
         },
         security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:read'] }, {}],
@@ -30,6 +55,7 @@ export const pathItems = {
         tags: ['common', 'app', 'resource'],
         description: 'Update an existing app resource.',
         operationId: 'updateAppResource',
+        parameters: [ifMatchParameter],
         requestBody: {
             required: true,
             $ref: '#/components/requestBodies/resource',
@@ -37,8 +63,10 @@ export const pathItems = {
         responses: {
             200: {
                 description: 'The updated resource.',
-                $ref: '#/components/responses/resource',
+                content: resourceContent,
+                headers: etagResponseHeader,
             },
+            412: preconditionFailedResponse,
         },
         security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
     },
@@ -46,6 +74,7 @@ export const pathItems = {
         tags: ['common', 'app', 'resource'],
         description: 'Patch an existing app resource.',
         operationId: 'patchAppResource',
+        parameters: [ifMatchParameter],
         requestBody: {
             required: true,
             $ref: '#/components/requestBodies/resource',
@@ -53,8 +82,10 @@ export const pathItems = {
         responses: {
             200: {
                 description: 'The patched resource.',
-                $ref: '#/components/responses/resource',
+                content: resourceContent,
+                headers: etagResponseHeader,
             },
+            412: preconditionFailedResponse,
         },
         security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
     },
@@ -62,11 +93,12 @@ export const pathItems = {
         tags: ['common', 'app', 'resource'],
         description: 'Delete an existing app resource.',
         operationId: 'deleteAppResource',
+        parameters: [ifMatchParameter],
         responses: {
             204: {
                 description: 'The app resource has been deleted successfully.',
-                $ref: '#/components/responses/resource',
             },
+            412: preconditionFailedResponse,
         },
         security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
     },

package/api/paths/apps/appId/secrets/oauth2/secretId.js

@@ -16,8 +16,24 @@ export const pathItems = {
                 content: {
                     'application/json': {
                         schema: {
-                            type: 'array',
-                            items: { $ref: '#/components/schemas/AppOAuth2Secret' },
+                            type: 'object',
+                            description: 'The public facing values of an app OAuth2 secret.',
+                            additionalProperties: false,
+                            properties: {
+                                authorizationUrl: {
+                                    type: 'string',
+                                    format: 'uri',
+                                    description: 'The OAuth2 redirect URL.',
+                                },
+                                clientId: {
+                                    type: 'string',
+                                    description: 'The public client id which identifies Appsemble to the authorization server.',
+                                },
+                                scope: {
+                                    type: 'string',
+                                    description: 'The login scope that will be requested from the authorization server.',
+                                },
+                            },
                         },
                     },
                 },

package/api/paths/apps/appId/secrets/saml/secretId.js

@@ -9,7 +9,7 @@ export const pathItems = {
         requestBody: {
             content: {
                 'application/json': {
-                    schema: {},
+                    schema: { $ref: '#/components/schemas/AppSamlSecret' },
                 },
             },
         },
@@ -19,7 +19,7 @@ export const pathItems = {
                 description: 'The updated SAML secret.',
                 content: {
                     'application/json': {
-                        schema: {},
+                        schema: { $ref: '#/components/schemas/AppSamlSecret' },
                     },
                 },
             },

package/api/paths/apps/appId/secrets/saml.js

@@ -6,7 +6,7 @@ export const pathItems = {
         requestBody: {
             content: {
                 'application/json': {
-                    schema: {},
+                    schema: { $ref: '#/components/schemas/AppSamlSecret' },
                 },
             },
         },
@@ -16,7 +16,7 @@ export const pathItems = {
                 description: 'A list of the SAML secrets for the app.',
                 content: {
                     'application/json': {
-                        schema: {},
+                        schema: { $ref: '#/components/schemas/AppSamlSecret' },
                     },
                 },
             },
@@ -33,7 +33,7 @@ export const pathItems = {
                     'application/json': {
                         schema: {
                             type: 'array',
-                            items: {},
+                            items: { $ref: '#/components/schemas/AppSamlSecret' },
                         },
                     },
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/utils",
-  "version": "0.36.10",
+  "version": "0.37.0",
   "description": "Utility functions used in Appsemble internally",
   "keywords": [
     "app",
@@ -39,8 +39,8 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/lang-sdk": "0.36.10",
-    "@appsemble/types": "0.36.10",
+    "@appsemble/lang-sdk": "0.37.0",
+    "@appsemble/types": "0.37.0",
     "@fortawesome/fontawesome-common-types": "^6.0.0",
     "axios": "^1.0.0",
     "langmap": "^0.0.16",