@appsemble/utils 0.21.3 → 0.22.0

package/README.md

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

package/api/components/schemas/ActionDefinition.js

@@ -72,6 +72,7 @@ export const ActionDefinition = {
                 { $ref: '#/components/schemas/TeamMembersActionDefinition' },
                 { $ref: '#/components/schemas/ThrowActionDefinition' },
                 { $ref: '#/components/schemas/UserLoginActionDefinition' },
+                { $ref: '#/components/schemas/UserLogoutActionDefinition' },
                 { $ref: '#/components/schemas/UserRegisterActionDefinition' },
                 { $ref: '#/components/schemas/UserUpdateActionDefinition' },
             ],

package/api/components/schemas/Asset.js

@@ -1,7 +1,7 @@
 import { normalized } from '../../../constants/index.js';
 export const Asset = {
     type: 'object',
-    description: 'The response object of an asset create call.',
+    description: 'The response object of an asset publish call.',
     additionalProperties: false,
     properties: {
         id: {

package/api/components/schemas/ResourceDefinition.js

@@ -61,6 +61,7 @@ name of the resource and how it should behave.
                 properties: {
                     resource: { type: 'string' },
                     create: referenceAction,
+                    patch: referenceAction,
                     update: referenceAction,
                     delete: referenceAction,
                 },
@@ -171,6 +172,28 @@ name of the resource and how it should behave.
                 },
             },
         },
+        patch: {
+            type: 'object',
+            description: "Overrides for 'patch' requests.",
+            additionalProperties: false,
+            properties: {
+                roles,
+                query,
+                method: {
+                    type: 'string',
+                    default: 'PATCH',
+                    description: 'HTTP method to use for this type of request.',
+                },
+                url: {
+                    type: 'string',
+                    default: '/api/apps/{appId}/{resource}/{id}',
+                    description: 'URL to use for this type of request.',
+                },
+                hooks: {
+                    $ref: '#/components/schemas/ResourceHooksDefinition',
+                },
+            },
+        },
         update: {
             type: 'object',
             description: "Overrides for 'update' requests.",

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

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

package/api/components/schemas/UserLogoutActionDefinition.js

@@ -0,0 +1,14 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const UserLogoutActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type'],
+    properties: {
+        type: {
+            enum: ['user.logout'],
+            description: 'Allow the users to logout of the application.',
+        },
+    },
+});
+//# sourceMappingURL=UserLogoutActionDefinition.js.map

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

@@ -112,6 +112,7 @@ export * from './Theme.js';
 export * from './ThrowActionDefinition.js';
 export * from './User.js';
 export * from './UserEmail.js';
+export * from './UserLogoutActionDefinition.js';
 export * from './UserLoginActionDefinition.js';
 export * from './UserRegisterActionDefinition.js';
 export * from './UserUpdateActionDefinition.js';

package/api/components/schemas/index.js

@@ -112,6 +112,7 @@ export * from './Theme.js';
 export * from './ThrowActionDefinition.js';
 export * from './User.js';
 export * from './UserEmail.js';
+export * from './UserLogoutActionDefinition.js';
 export * from './UserLoginActionDefinition.js';
 export * from './UserRegisterActionDefinition.js';
 export * from './UserUpdateActionDefinition.js';

package/api/components/securitySchemes/cli.js

@@ -11,6 +11,7 @@ export const cli = {
             scopes: {
                 'apps:write': 'Create and update apps',
                 'blocks:write': 'Register and update blocks, and publish new block versions.',
+                'blocks:delete': 'Delete specific block versions.',
                 'organizations:write': 'Create and manage organizations.',
                 'resources:read': 'Read app resources on behalf of a user.',
                 'resources:write': 'Modify app resources on behalf of a user.',

package/api/paths/blocks.js

@@ -102,6 +102,17 @@ export const paths = {
                 },
             },
         },
+        delete: {
+            tags: ['block', 'delete'],
+            description: 'Delete a single block version.',
+            operationId: 'removeBlockVersion',
+            responses: {
+                204: {
+                    description: 'Block version has successfully been deleted',
+                },
+            },
+            security: [{ cli: ['blocks:delete'] }],
+        },
     },
     '/api/blocks/@{organizationId}/{blockId}/versions/{blockVersion}/asset': {
         parameters: [

package/api/paths/organizations.js

@@ -125,6 +125,17 @@ export const paths = {
             },
             security: [{ studio: [] }, { cli: ['organizations:write'] }],
         },
+        delete: {
+            tags: ['organization'],
+            description: 'Delete an organization.',
+            operationId: 'deleteOrganization',
+            responses: {
+                200: {
+                    description: 'successfully deleted organization',
+                },
+            },
+            security: [{ studio: [] }, {}],
+        },
     },
     '/api/organizations/{organizationId}/icon': {
         parameters: [{ $ref: '#/components/parameters/organizationId' }],

package/api/paths/user.js

@@ -476,5 +476,44 @@ export const paths = {
             },
         },
     },
+    '/api/subscribed': {
+        get: {
+            tags: ['user'],
+            description: 'Get a list of active and verified users subscribed to the appsemble newsletter',
+            operationId: 'getSubscribedUsers',
+            responses: {
+                200: { description: 'List of subscribed users' },
+                401: { description: 'Invalid or missing admin API secret' },
+            },
+        },
+    },
+    '/api/unsubscribe': {
+        post: {
+            tags: ['user'],
+            description: 'Unsubscribe a user from the newsletter',
+            operationId: 'unsubscribe',
+            responses: {
+                201: { description: 'Unsubscribed successfully' },
+                401: { description: 'Invalid or missing admin API secret' },
+            },
+            requestBody: {
+                required: true,
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            required: ['email'],
+                            properties: {
+                                email: {
+                                    type: 'string',
+                                    format: 'email',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
 };
 //# sourceMappingURL=user.js.map

package/constants/Permission.d.ts

@@ -26,53 +26,61 @@ export declare enum Permission {
      * The permission to edit the name and logo of an organization.
      */
     EditOrganization = 5,
+    /**
+     * The permission to delete an organization if it doesn't have any apps.
+     */
+    DeleteOrganization = 6,
     /**
      * The permission to invite new members into an organization,
      * removing existing invites, and resending invites.
      */
-    InviteMember = 6,
+    InviteMember = 7,
     /**
      * The permission to create and delete assets.
      */
-    ManageAssets = 7,
+    ManageAssets = 8,
     /**
      * The permission to remove organization members.
      */
-    ManageMembers = 8,
+    ManageMembers = 9,
     /**
      * The permission to create, edit, and delete resources.
      */
-    ManageResources = 9,
+    ManageResources = 10,
     /**
      * The permission to change the roles of organization members.
      */
-    ManageRoles = 10,
+    ManageRoles = 11,
     /**
      * The permission to create and delete teams and manage its members.
      */
-    ManageTeams = 11,
+    ManageTeams = 12,
     /**
      * The permission to publish blocks for an organization.
      */
-    PublishBlocks = 12,
+    PublishBlocks = 13,
+    /**
+     * The permission to delete blocks for an organization.
+     */
+    DeleteBlocks = 14,
     /**
      * The permission to send manual push notifications for an app.
      */
-    PushNotifications = 13,
+    PushNotifications = 15,
     /**
      * The permission to read assets.
      */
-    ReadAssets = 14,
+    ReadAssets = 16,
     /**
      * The permission to read resources.
      */
-    ReadResources = 15,
+    ReadResources = 17,
     /**
      * The permission to view private apps of an organization.
      */
-    ViewApps = 16,
+    ViewApps = 18,
     /**
      * The permission to view the list of members in an organization.
      */
-    ViewMembers = 17
+    ViewMembers = 19
 }

package/constants/Permission.js

@@ -27,54 +27,62 @@ export var Permission;
      * The permission to edit the name and logo of an organization.
      */
     Permission[Permission["EditOrganization"] = 5] = "EditOrganization";
+    /**
+     * The permission to delete an organization if it doesn't have any apps.
+     */
+    Permission[Permission["DeleteOrganization"] = 6] = "DeleteOrganization";
     /**
      * The permission to invite new members into an organization,
      * removing existing invites, and resending invites.
      */
-    Permission[Permission["InviteMember"] = 6] = "InviteMember";
+    Permission[Permission["InviteMember"] = 7] = "InviteMember";
     /**
      * The permission to create and delete assets.
      */
-    Permission[Permission["ManageAssets"] = 7] = "ManageAssets";
+    Permission[Permission["ManageAssets"] = 8] = "ManageAssets";
     /**
      * The permission to remove organization members.
      */
-    Permission[Permission["ManageMembers"] = 8] = "ManageMembers";
+    Permission[Permission["ManageMembers"] = 9] = "ManageMembers";
     /**
      * The permission to create, edit, and delete resources.
      */
-    Permission[Permission["ManageResources"] = 9] = "ManageResources";
+    Permission[Permission["ManageResources"] = 10] = "ManageResources";
     /**
      * The permission to change the roles of organization members.
      */
-    Permission[Permission["ManageRoles"] = 10] = "ManageRoles";
+    Permission[Permission["ManageRoles"] = 11] = "ManageRoles";
     /**
      * The permission to create and delete teams and manage its members.
      */
-    Permission[Permission["ManageTeams"] = 11] = "ManageTeams";
+    Permission[Permission["ManageTeams"] = 12] = "ManageTeams";
     /**
      * The permission to publish blocks for an organization.
      */
-    Permission[Permission["PublishBlocks"] = 12] = "PublishBlocks";
+    Permission[Permission["PublishBlocks"] = 13] = "PublishBlocks";
+    /**
+     * The permission to delete blocks for an organization.
+     */
+    Permission[Permission["DeleteBlocks"] = 14] = "DeleteBlocks";
     /**
      * The permission to send manual push notifications for an app.
      */
-    Permission[Permission["PushNotifications"] = 13] = "PushNotifications";
+    Permission[Permission["PushNotifications"] = 15] = "PushNotifications";
     /**
      * The permission to read assets.
      */
-    Permission[Permission["ReadAssets"] = 14] = "ReadAssets";
+    Permission[Permission["ReadAssets"] = 16] = "ReadAssets";
     /**
      * The permission to read resources.
      */
-    Permission[Permission["ReadResources"] = 15] = "ReadResources";
+    Permission[Permission["ReadResources"] = 17] = "ReadResources";
     /**
      * The permission to view private apps of an organization.
      */
-    Permission[Permission["ViewApps"] = 16] = "ViewApps";
+    Permission[Permission["ViewApps"] = 18] = "ViewApps";
     /**
      * The permission to view the list of members in an organization.
      */
-    Permission[Permission["ViewMembers"] = 17] = "ViewMembers";
+    Permission[Permission["ViewMembers"] = 19] = "ViewMembers";
 })(Permission || (Permission = {}));
 //# sourceMappingURL=Permission.js.map

package/constants/roles.js

@@ -21,10 +21,12 @@ const Maintainer = [
     Permission.InviteMember,
     Permission.ManageTeams,
     Permission.PublishBlocks,
+    Permission.DeleteBlocks,
 ];
 const Owner = [
     ...Maintainer,
     Permission.EditOrganization,
+    Permission.DeleteOrganization,
     Permission.ManageMembers,
     Permission.ManageRoles,
 ];

package/constants/scopes.d.ts

@@ -1,4 +1,4 @@
 /**
  * All known OAuth2 scopes for client credentials.
  */
-export declare const scopes: readonly ["apps:write", "blocks:write", "organizations:write", "resources:read", "resources:write", "assets:write", "teams:read", "teams:write"];
+export declare const scopes: readonly ["apps:write", "blocks:write", "blocks:delete", "organizations:write", "resources:read", "resources:write", "assets:write", "teams:read", "teams:write"];

package/constants/scopes.js

@@ -4,6 +4,7 @@
 export const scopes = [
     'apps:write',
     'blocks:write',
+    'blocks:delete',
     'organizations:write',
     'resources:read',
     'resources:write',

package/formatRequestAction.js

@@ -4,6 +4,7 @@ export function formatRequestAction({ method = 'GET', query, ...action }, data,
         url: String(remap(action.url, data, context)),
         headers: {},
         params: remap(query, data, context),
+        responseType: 'arraybuffer',
     };
 }
 //# sourceMappingURL=formatRequestAction.js.map

package/package.json

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

package/reference-schemas/remappers/dates.js

@@ -39,7 +39,7 @@ Result:
 `,
     },
     'date.format': {
-        enum: [null],
+        enum: ['string', null],
         description: `Format a date according to the RFC3339 format.
 
 Here is an example of a RFC3339 complicit date:
@@ -47,7 +47,7 @@ Here is an example of a RFC3339 complicit date:
 
 In an app definition, it’s best to use this when you want to display a date in a specific format.
 For example, if your app has a form with a Datepicker field the incoming data will be formatted
-as a simple date format. If you want to format it tot he RFC3339 format, you can use this remapper.
+as a simple date format. If you want to format it to the RFC3339 format, you can use this remapper.
 
 When you submit a form with a DateField, the internal output looks like this:
 
@@ -63,7 +63,24 @@ date.format: null
 
 Result:
 \`\`\`js
-"2023-07-03T09:09:50.000Z"
+"2023-07-02T22:00:00.000Z"
+\`\`\`
+
+The remapper can also be used to format a date or timestamp using a custom format.
+
+\`\`\`js
+"2023-07-02T22:00:00.000Z"
+\`\`\`
+
+You can then format the date with any supported pattern, please refer to https://date-fns.org/docs/format for the supported patterns.
+
+\`\`\`yaml
+date.format: yyyy-MM-dd
+\`\`\`
+
+Result:
+\`\`\`js
+2023-07-03
 \`\`\`
 `,
     },

package/remap.js

@@ -1,4 +1,4 @@
-import { addMilliseconds, parse, parseISO } from 'date-fns';
+import { addMilliseconds, format, parse, parseISO } from 'date-fns';
 import equal from 'fast-deep-equal';
 import { createEvent } from 'ics';
 import parseDuration from 'parse-duration';
@@ -233,7 +233,7 @@ const mapperImplementations = {
         }
         return result;
     },
-    'date.parse': (format, input) => format ? parse(input, format, new Date()) : parseISO(input),
+    'date.parse': (fmt, input) => (fmt ? parse(input, fmt, new Date()) : parseISO(input)),
     'date.now': () => new Date(),
     'date.add'(time, input) {
         const expireDuration = parseDuration(time);
@@ -248,7 +248,7 @@ const mapperImplementations = {
             : typeof input === 'number'
                 ? new Date(input)
                 : parseISO(String(input));
-        return date.toJSON();
+        return args ? format(date, args) : date.toJSON();
     },
     'null.strip': (args, input) => stripNullValues(input, args || {}),
     'random.choice': (args, input) => Array.isArray(input) ? input[Math.floor(Math.random() * input.length)] : input,

package/remap.test.js

@@ -183,6 +183,21 @@ describe('date.format', () => {
             mappers: { 'date.format': null },
             expected: '1970-01-01T00:00:00.000Z',
         },
+        'format date objects to custom format': {
+            input: new Date('2020-01-02T03:04:05Z'),
+            mappers: { 'date.format': 'dd-MM-yyyy' },
+            expected: '02-01-2020',
+        },
+        'format date strings to custom format': {
+            input: '2020-01-02T03:04:05Z',
+            mappers: { 'date.format': 'yyyy-MM-dd' },
+            expected: '2020-01-02',
+        },
+        'format unix timestamps to custom format': {
+            input: 0,
+            mappers: { 'date.format': 'MM/dd/yyyy' },
+            expected: '01/01/1970',
+        },
     });
 });
 describe('log', () => {

package/theme.test.js

@@ -1,4 +1,4 @@
-import bulmaPkg from 'bulma/package.json' assert { type: 'json' };
+import bulmaPkg from 'bulma/package.json';
 import { createThemeURL, mergeThemes } from './theme.js';
 describe('mergeThemes', () => {
     it('should use the base theme as default', () => {

package/vitest.config.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("vitest/dist/config.js").UserProjectConfigExport;
-export default _default;