@appsemble/utils 0.30.3 → 0.30.9

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.30.3/config/assets/logo.svg) Appsemble Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.30.9/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.30.3/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.30.3)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.30.9/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.30.9)
 [![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.30.3/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.30.9/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/api/components/parameters/roles.js

@@ -3,17 +3,7 @@ export const roles = {
     in: 'query',
     description: 'The roles of app members on which to perform an operation',
     schema: {
-        oneOf: [
-            {
-                type: 'array',
-                items: {
-                    $ref: '#/components/schemas/AppMember/properties/role',
-                },
-            },
-            {
-                type: 'string',
-            },
-        ],
+        type: 'string',
     },
 };
 //# sourceMappingURL=roles.js.map

package/api/components/schemas/ActionDefinition.js

@@ -53,6 +53,7 @@ export const ActionDefinition = {
                 { $ref: '#/components/schemas/ResourceCreateActionDefinition' },
                 { $ref: '#/components/schemas/ResourceDeleteActionDefinition' },
                 { $ref: '#/components/schemas/ResourceGetActionDefinition' },
+                { $ref: '#/components/schemas/ResourceHistoryGetActionDefinition' },
                 { $ref: '#/components/schemas/ResourceQueryActionDefinition' },
                 { $ref: '#/components/schemas/ResourceSubscriptionStatusActionDefinition' },
                 { $ref: '#/components/schemas/ResourceSubscriptionSubscribeActionDefinition' },

package/api/components/schemas/ContainerPageDefinition.js

@@ -3,7 +3,8 @@ import { extendJSONSchema } from './utils.js';
 export const ContainerPageDefinition = extendJSONSchema(BasePageDefinition, {
     type: 'object',
     additionalProperties: false,
-    description: `Use this page type to group pages in the menu, this doesn't actually group pages for now. Following is an example of how this can be used
+    description: `Groups pages together under a collapsible parent page. Following is an example of
+how this can be used:
 \`\`\`yaml
 pages:
   - name: Page 1

package/api/components/schemas/FlowPageDefinition.js

@@ -2,7 +2,7 @@ import { BasePageDefinition } from './BasePageDefinition.js';
 import { extendJSONSchema } from './utils.js';
 export const FlowPageDefinition = extendJSONSchema(BasePageDefinition, {
     type: 'object',
-    description: 'This describes what a page will look like in the app.',
+    description: 'Shows a set of sub pages in a certain order which the user can navigate through.',
     required: ['type', 'steps'],
     additionalProperties: false,
     properties: {

package/api/components/schemas/LoopPageDefinition.js

@@ -2,13 +2,7 @@ import { BasePageDefinition } from './BasePageDefinition.js';
 import { extendJSONSchema } from './utils.js';
 export const LoopPageDefinition = extendJSONSchema(BasePageDefinition, {
     type: 'object',
-    description: `This describes what a loop page will look like in the app.
-
-!!
-This feature is still under development and is very unstable
-!!
-
-  `,
+    description: 'Generates sub pages dynamically based on data and display in a flow page.',
     required: ['type', 'foreach', 'actions'],
     additionalProperties: false,
     properties: {

package/api/components/schemas/RequestActionDefinition.js

@@ -54,6 +54,22 @@ disabled by setting this to \`false\`
             description: 'The name of the schema to validate against before submitting data.',
             $ref: '#/components/schemas/JSONSchema',
         },
+        headers: {
+            type: 'object',
+            description: 'The headers to be set for the outgoing request',
+            additionalProperties: false,
+            properties: {
+                'Content-Type': {
+                    description: 'Content type for the outgoing request',
+                    enum: [
+                        'application/xml',
+                        'text/plain',
+                        'application/x-www-form-urlencoded',
+                        'multipart/form-data',
+                    ],
+                },
+            },
+        },
     },
 });
 //# sourceMappingURL=RequestActionDefinition.js.map

package/api/components/schemas/ResourceCountActionDefinition.js

@@ -18,5 +18,5 @@ export const ResourceCountActionDefinition = extendJSONSchema(RequestActionDefin
             description: 'If only the resources created by the authenticated app member should be included',
         },
     },
-}, ['url']);
+}, ['url', 'method']);
 //# sourceMappingURL=ResourceCountActionDefinition.js.map

package/api/components/schemas/ResourceDeleteActionDefinition.js

@@ -14,5 +14,5 @@ export const ResourceDeleteActionDefinition = extendJSONSchema(RequestActionDefi
             description: 'The type of the resource to delete.',
         },
     },
-}, ['url']);
+}, ['url', 'method']);
 //# sourceMappingURL=ResourceDeleteActionDefinition.js.map

package/api/components/schemas/ResourceGetActionDefinition.js

@@ -18,5 +18,5 @@ export const ResourceGetActionDefinition = extendJSONSchema(RequestActionDefinit
             description: 'The view to use for the resource.',
         },
     },
-}, ['url']);
+}, ['url', 'method']);
 //# sourceMappingURL=ResourceGetActionDefinition.js.map

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

@@ -0,0 +1 @@
+export declare const ResourceHistoryGetActionDefinition: import("openapi-types").OpenAPIV3.SchemaObject;

package/api/components/schemas/ResourceHistoryGetActionDefinition.js

@@ -0,0 +1,18 @@
+import { RequestActionDefinition } from './RequestActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const ResourceHistoryGetActionDefinition = extendJSONSchema(RequestActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'resource'],
+    properties: {
+        type: {
+            enum: ['resource.history.get'],
+            description: 'Get the complete history of a resource.',
+        },
+        resource: {
+            type: 'string',
+            description: 'The type of the resource to get.',
+        },
+    },
+}, ['url']);
+//# sourceMappingURL=ResourceHistoryGetActionDefinition.js.map

package/api/components/schemas/ResourcePatchActionDefinition.js

@@ -14,5 +14,5 @@ export const ResourcePatchActionDefinition = extendJSONSchema(RequestActionDefin
             description: 'The type of the resource to patch.',
         },
     },
-}, ['url']);
+}, ['url', 'method']);
 //# sourceMappingURL=ResourcePatchActionDefinition.js.map

package/api/components/schemas/ResourceQueryActionDefinition.js

@@ -22,5 +22,5 @@ export const ResourceQueryActionDefinition = extendJSONSchema(RequestActionDefin
             description: 'If only the resources created by the authenticated app member should be included',
         },
     },
-}, ['url']);
+}, ['url', 'method']);
 //# sourceMappingURL=ResourceQueryActionDefinition.js.map

package/api/components/schemas/ResourceUpdateActionDefinition.js

@@ -14,5 +14,5 @@ export const ResourceUpdateActionDefinition = extendJSONSchema(RequestActionDefi
             description: 'The type of the resource to update.',
         },
     },
-}, ['url']);
+}, ['url', 'method']);
 //# sourceMappingURL=ResourceUpdateActionDefinition.js.map

package/api/components/schemas/TabsPageDefinition.js

@@ -2,7 +2,7 @@ import { BasePageDefinition } from './BasePageDefinition.js';
 import { extendJSONSchema } from './utils.js';
 export const TabsPageDefinition = extendJSONSchema(BasePageDefinition, {
     type: 'object',
-    description: 'This describes what a page will look like in the app.',
+    description: 'Shows a set of subpages as tabs at the top of the page.',
     oneOf: [
         {
             required: ['type', 'tabs'],

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

@@ -83,6 +83,7 @@ export * from './ResourceCreateActionDefinition.js';
 export * from './ResourceDefinition.js';
 export * from './ResourceDeleteActionDefinition.js';
 export * from './ResourceGetActionDefinition.js';
+export * from './ResourceHistoryGetActionDefinition.js';
 export * from './ResourceHistoryDefinition.js';
 export * from './ResourceHooksDefinition.js';
 export * from './ResourceQueryActionDefinition.js';

package/api/components/schemas/index.js

@@ -83,6 +83,7 @@ export * from './ResourceCreateActionDefinition.js';
 export * from './ResourceDefinition.js';
 export * from './ResourceDeleteActionDefinition.js';
 export * from './ResourceGetActionDefinition.js';
+export * from './ResourceHistoryGetActionDefinition.js';
 export * from './ResourceHistoryDefinition.js';
 export * from './ResourceHooksDefinition.js';
 export * from './ResourceQueryActionDefinition.js';

package/api/paths/apps/appId/assets.js

@@ -90,7 +90,7 @@ export const pathItems = {
                 description: 'The app assets have been deleted successfully.',
             },
         },
-        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['assets:write'] }, {}],
     },
 };
 //# sourceMappingURL=assets.js.map

package/api/paths/apps/appId/invites/resend.d.ts

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

package/api/paths/apps/appId/invites/resend.js

@@ -0,0 +1,32 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    post: {
+        tags: ['app'],
+        description: 'Request to resend an invitation.',
+        operationId: 'resendAppInvite',
+        requestBody: {
+            description: 'The email of the person to resend the invitation to.',
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['email'],
+                        properties: {
+                            email: {
+                                type: 'string',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The invite has been sent.',
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=resend.js.map

package/api/paths/apps/appId/invites.js

@@ -75,5 +75,34 @@ export const pathItems = {
         },
         security: [{ studio: [] }, { app: ['app:write'] }],
     },
+    delete: {
+        tags: ['app', 'invite'],
+        description: 'Revoke an app member invitation.',
+        operationId: 'deleteAppInvite',
+        requestBody: {
+            description: 'The email address to revoke the invite of.',
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['email'],
+                        properties: {
+                            email: {
+                                type: 'string',
+                                format: 'email',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The invitation has been successfully revoked.',
+            },
+        },
+        security: [{ studio: [] }],
+    },
 };
 //# sourceMappingURL=invites.js.map

package/api/paths/apps/appId/resources/versions.js

@@ -3,6 +3,7 @@ export const pathItems = {
         { $ref: '#/components/parameters/appId' },
         { $ref: '#/components/parameters/resourceType' },
         { $ref: '#/components/parameters/resourceId' },
+        { $ref: '#/components/parameters/selectedGroupId' },
     ],
     get: {
         tags: ['main', 'app', 'resource', 'version'],
@@ -23,7 +24,7 @@ export const pathItems = {
                 },
             },
         },
-        security: [{ studio: [] }],
+        security: [{ studio: [] }, { app: ['resources:manage'] }],
     },
 };
 //# sourceMappingURL=versions.js.map

package/api/paths/groups/groupId/invites/resend.d.ts

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

package/api/paths/groups/groupId/invites/resend.js

@@ -0,0 +1,32 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/groupId' }],
+    post: {
+        tags: ['group'],
+        description: 'Request to resend an invitation.',
+        operationId: 'resendGroupInvite',
+        requestBody: {
+            description: 'The email of the person to resend the invitation to.',
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['email'],
+                        properties: {
+                            email: {
+                                type: 'string',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The invite has been sent.',
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=resend.js.map

package/api/paths/groups/groupId/invites.js

@@ -83,5 +83,34 @@ export const pathItems = {
         },
         security: [{ studio: [] }, { app: ['groups:write'] }, { cli: ['groups:write'] }],
     },
+    delete: {
+        tags: ['group', 'invite'],
+        description: 'Revoke a group member invitation.',
+        operationId: 'deleteGroupInvite',
+        requestBody: {
+            description: 'The email address to revoke the invite of.',
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['email'],
+                        properties: {
+                            email: {
+                                type: 'string',
+                                format: 'email',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The invitation has been successfully revoked.',
+            },
+        },
+        security: [{ studio: [] }],
+    },
 };
 //# sourceMappingURL=invites.js.map

package/api/paths/index.d.ts

@@ -23,6 +23,7 @@ export declare const paths: {
     '/api/apps/{appId}/export': import("openapi-types").OpenAPIV3.PathItemObject<{}>;
     '/api/apps/{appId}/groups': import("openapi-types").OpenAPIV3.PathItemObject<{}>;
     '/api/apps/{appId}/icon': import("openapi-types").OpenAPIV3.PathItemObject<{}>;
+    '/api/apps/{appId}/invites/resend': import("openapi-types").OpenAPIV3.PathItemObject<{}>;
     '/api/apps/{appId}/invites': import("openapi-types").OpenAPIV3.PathItemObject<{}>;
     '/api/apps/{appId}/lock': import("openapi-types").OpenAPIV3.PathItemObject<{}>;
     '/api/apps/{appId}/maskable-icon': import("openapi-types").OpenAPIV3.PathItemObject<{}>;
@@ -121,6 +122,7 @@ export declare const paths: {
     '/api/group-invites/{token}': import("openapi-types").OpenAPIV3.PathItemObject<{}>;
     '/api/group-members/{groupMemberId}/role': import("openapi-types").OpenAPIV3.PathItemObject<{}>;
     '/api/group-members/{groupMemberId}': import("openapi-types").OpenAPIV3.PathItemObject<{}>;
+    '/api/groups/{groupId}/invites/resend': import("openapi-types").OpenAPIV3.PathItemObject<{}>;
     '/api/groups/{groupId}/invites': import("openapi-types").OpenAPIV3.PathItemObject<{}>;
     '/api/groups/{groupId}/members': import("openapi-types").OpenAPIV3.PathItemObject<{}>;
     '/api/groups/{groupId}': import("openapi-types").OpenAPIV3.PathItemObject<{}>;

package/api/paths/index.js

@@ -28,6 +28,7 @@ import { pathItems as appsAppIdEmail } from './apps/appId/email.js';
 import { pathItems as appsAppIdExport } from './apps/appId/export.js';
 import { pathItems as appsAppIdGroups } from './apps/appId/groups.js';
 import { pathItems as appsAppIdIcon } from './apps/appId/icon.js';
+import { pathItems as appsAppIdInvitesResend } from './apps/appId/invites/resend.js';
 import { pathItems as appsAppIdInvites } from './apps/appId/invites.js';
 import { pathItems as appsAppIdLock } from './apps/appId/lock.js';
 import { pathItems as appsAppIdMaskableIcon } from './apps/appId/maskableIcon.js';
@@ -102,6 +103,7 @@ import { pathItems as groupInvitesTokenRespond } from './group-invites/token/res
 import { pathItems as groupInvitesToken } from './group-invites/token.js';
 import { pathItems as groupsMembersGroupMemberIdRole } from './group-members/groupMemberId/role.js';
 import { pathItems as groupsMembersGroupMemberId } from './group-members/groupMemberId.js';
+import { pathItems as groupsGroupIdInvitesResend } from './groups/groupId/invites/resend.js';
 import { pathItems as groupsGroupIdInvites } from './groups/groupId/invites.js';
 import { pathItems as groupsGroupIdMembers } from './groups/groupId/members.js';
 import { pathItems as groupsGroupId } from './groups/groupId.js';
@@ -170,6 +172,7 @@ export const paths = {
     '/api/apps/{appId}/export': appsAppIdExport,
     '/api/apps/{appId}/groups': appsAppIdGroups,
     '/api/apps/{appId}/icon': appsAppIdIcon,
+    '/api/apps/{appId}/invites/resend': appsAppIdInvitesResend,
     '/api/apps/{appId}/invites': appsAppIdInvites,
     '/api/apps/{appId}/lock': appsAppIdLock,
     '/api/apps/{appId}/maskable-icon': appsAppIdMaskableIcon,
@@ -270,6 +273,7 @@ export const paths = {
     '/api/group-invites/{token}': groupInvitesToken,
     '/api/group-members/{groupMemberId}/role': groupsMembersGroupMemberIdRole,
     '/api/group-members/{groupMemberId}': groupsMembersGroupMemberId,
+    '/api/groups/{groupId}/invites/resend': groupsGroupIdInvitesResend,
     '/api/groups/{groupId}/invites': groupsGroupIdInvites,
     '/api/groups/{groupId}/members': groupsGroupIdMembers,
     '/api/groups/{groupId}': groupsGroupId,

package/api/paths/resourceHistory.d.ts

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

package/api/paths/resourceHistory.js

@@ -0,0 +1,31 @@
+export const paths = {
+    '/api/apps/{appId}/resources/{resourceType}/{resourceId}/history': {
+        parameters: [
+            { $ref: '#/components/parameters/appId' },
+            { $ref: '#/components/parameters/resourceType' },
+            { $ref: '#/components/parameters/resourceId' },
+        ],
+        get: {
+            tags: ['resource'],
+            description: 'Get the known history of a resource',
+            operationId: 'getResourceHistory',
+            responses: {
+                200: {
+                    description: 'The resource that matches the given id.',
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: 'array',
+                                items: {
+                                    $ref: '#/components/responses/resource',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            security: [{ studio: [] }, { app: ['resources:manage'] }],
+        },
+    },
+};
+//# sourceMappingURL=resourceHistory.js.map

package/authorization.js

@@ -1,6 +1,6 @@
-import { appOrganizationPermissionMapping, AppPermission, PredefinedAppRole, predefinedAppRolePermissions, predefinedOrganizationRolePermissions, } from '@appsemble/types';
+import { appOrganizationPermissionMapping, AppPermission, predefinedAppRolePermissions, predefinedOrganizationRolePermissions, } from '@appsemble/types';
 function checkAppPermissions(acquiredPermissions, requiredPermissions) {
-    const customAppResourcePermissionPattern = /^\$resource:[^:]+:(get|query|create|delete|patch|update)$/;
+    const customAppResourcePermissionPattern = /^\$resource:[^:]+:(get|history:get|query|create|delete|patch|update)$/;
     const customAppOwnResourcePermissionPattern = /^\$resource:[^:]+:own:(get|query|delete|patch|update)$/;
     const customAppResourceViewPermissionPattern = /^\$resource:[^:]+:(get|query):[^:]+$/;
     return requiredPermissions.every((p) => {
@@ -76,10 +76,7 @@ export function checkGuestAppPermissions(appSecurityDefinition, requiredPermissi
     return checkAppPermissions(guestPermissions, requiredPermissions);
 }
 export function getAppRoles(appSecurityDefinition) {
-    return Array.from(new Set([
-        ...Object.keys((appSecurityDefinition === null || appSecurityDefinition === void 0 ? void 0 : appSecurityDefinition.roles) || {}),
-        ...Object.keys(PredefinedAppRole),
-    ]));
+    return Array.from(new Set(Object.keys((appSecurityDefinition === null || appSecurityDefinition === void 0 ? void 0 : appSecurityDefinition.roles) || {})));
 }
 export function getAppPossibleGuestPermissions(appDefinition) {
     const possibleAllViews = {};
@@ -105,6 +102,7 @@ export function getAppPossibleGuestPermissions(appDefinition) {
             `$resource:${resourceName}:create`,
             `$resource:${resourceName}:query`,
             `$resource:${resourceName}:get`,
+            `$resource:${resourceName}:history:get`,
             `$resource:${resourceName}:update`,
             `$resource:${resourceName}:patch`,
             `$resource:${resourceName}:delete`,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/utils",
-  "version": "0.30.3",
+  "version": "0.30.9",
   "description": "Utility functions used in Appsemble internally",
   "keywords": [
     "app",
@@ -37,7 +37,7 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/types": "0.30.3",
+    "@appsemble/types": "0.30.9",
     "axios": "^1.0.0",
     "cron-parser": "^4.0.0",
     "date-fns": "^2.0.0",

package/validation.js

@@ -7,8 +7,8 @@ import { has } from './has.js';
 import { findPageByName, getAppInheritedRoles, getAppPossibleGuestPermissions, getAppPossiblePermissions, getAppRolePermissions, normalize, partialNormalized, } from './index.js';
 import { iterApp } from './iterApp.js';
 import { serverActions } from './serverActions.js';
-const allResourcePermissionPattern = /^\$resource:all:(get|query|create|delete|patch|update)$/;
-const resourcePermissionPattern = /^\$resource:[^:]+:(get|query|create|delete|patch|update)$/;
+const allResourcePermissionPattern = /^\$resource:all:(get|history:get|query|create|delete|patch|update)$/;
+const resourcePermissionPattern = /^\$resource:[^:]+:(get|history:get|query|create|delete|patch|update)$/;
 const allOwnResourcePermissionPattern = /^\$resource:all:own:(get|query|delete|patch|update)$/;
 const ownResourcePermissionPattern = /^\$resource:[^:]+:own:(get|query|delete|patch|update)$/;
 const allResourceViewPermissionPattern = /^\$resource:all:(get|query):[^:]+$/;