@appsemble/utils 0.28.6 → 0.28.8

package/README.md

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

package/allActions.d.ts

@@ -0,0 +1,3 @@
+import { type ActionDefinition } from '@appsemble/types';
+export declare const allActions: Set<string>;
+export type ActionName = ActionDefinition['type'];

package/allActions.js

@@ -0,0 +1,9 @@
+import { schemas } from './index.js';
+const [, kinds] = schemas.ActionDefinition.allOf;
+export const allActions = new Set(kinds.anyOf.map(({ $ref }) => {
+    const ref = $ref.split('/').at(-1);
+    const action = schemas[ref];
+    const name = action.properties.type.enum[0];
+    return name;
+}));
+//# sourceMappingURL=allActions.js.map

package/api/components/schemas/ActionDefinition.js

@@ -38,6 +38,7 @@ export const ActionDefinition = {
                 { $ref: '#/components/schemas/FlowBackActionDefinition' },
                 { $ref: '#/components/schemas/FlowFinishActionDefinition' },
                 { $ref: '#/components/schemas/FlowNextActionDefinition' },
+                { $ref: '#/components/schemas/FlowCancelActionDefinition' },
                 { $ref: '#/components/schemas/FlowToActionDefinition' },
                 { $ref: '#/components/schemas/LinkActionDefinition' },
                 { $ref: '#/components/schemas/LinkBackActionDefinition' },

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

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

package/api/components/schemas/FlowCancelActionDefinition.js

@@ -0,0 +1,14 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const FlowCancelActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type'],
+    properties: {
+        type: {
+            enum: ['flow.cancel'],
+            description: "On [flow pages](#flow-page-definition-sub-pages), cancel the ongoing flow and invoke the page's [`onFlowFinish`](#flow-page-actions-definition-on-flow-finish) action.",
+        },
+    },
+});
+//# sourceMappingURL=FlowCancelActionDefinition.js.map

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

@@ -32,6 +32,7 @@ export * from './EventsDefinition.js';
 export * from './FlowBackActionDefinition.js';
 export * from './FlowFinishActionDefinition.js';
 export * from './FlowNextActionDefinition.js';
+export * from './FlowCancelActionDefinition.js';
 export * from './FlowPageActionsDefinition.js';
 export * from './FlowPageDefinition.js';
 export * from './FlowToActionDefinition.js';

package/api/components/schemas/index.js

@@ -32,6 +32,7 @@ export * from './EventsDefinition.js';
 export * from './FlowBackActionDefinition.js';
 export * from './FlowFinishActionDefinition.js';
 export * from './FlowNextActionDefinition.js';
+export * from './FlowCancelActionDefinition.js';
 export * from './FlowPageActionsDefinition.js';
 export * from './FlowPageDefinition.js';
 export * from './FlowToActionDefinition.js';

package/index.d.ts

@@ -24,6 +24,7 @@ export * from './theme.js';
 export * from './langmap.js';
 export * from './i18n.js';
 export * from './examples.js';
+export * from './allActions.js';
 export * from './serverActions.js';
 export * from './validation.js';
 export * from './convertToCsv.js';

package/index.js

@@ -24,6 +24,7 @@ export * from './theme.js';
 export * from './langmap.js';
 export * from './i18n.js';
 export * from './examples.js';
+export * from './allActions.js';
 export * from './serverActions.js';
 export * from './validation.js';
 export * from './convertToCsv.js';

package/package.json

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

package/serverActions.d.ts

@@ -1 +1,2 @@
-export declare const serverActions: Set<string>;
+export declare const serverActions: Set<"log" | "condition" | "each" | "email" | "noop" | "notify" | "static" | "throw" | "request" | "resource.create" | "resource.delete" | "resource.get" | "resource.patch" | "resource.query" | "resource.update">;
+export type ServerActionName = typeof serverActions extends Set<infer T> ? T : never;

package/validation.js

@@ -491,7 +491,7 @@ function validateActions(definition, report) {
     const urlRegex = new RegExp(`^${partialNormalized.source}:`);
     iterApp(definition, {
         onAction(action, path) {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
             if (path[0] === 'cron' && !serverActions.has(action.type)) {
                 report(action.type, 'action type is not supported for cron jobs', [...path, 'type']);
                 return;
@@ -501,10 +501,10 @@ function validateActions(definition, report) {
                 return;
             }
             if (['user.register', 'user.create', 'user.update'].includes(action.type) &&
-                Object.values(action.properties)[0] &&
-                ((_a = definition.users) === null || _a === void 0 ? void 0 : _a.properties)) {
-                for (const propertyName of Object.keys(Object.values(action.properties)[0])) {
-                    if (!((_b = definition.users) === null || _b === void 0 ? void 0 : _b.properties[propertyName])) {
+                Object.values((_a = action.properties) !== null && _a !== void 0 ? _a : {})[0] &&
+                ((_b = definition.users) === null || _b === void 0 ? void 0 : _b.properties)) {
+                for (const propertyName of Object.keys(Object.values((_c = action.properties) !== null && _c !== void 0 ? _c : {})[0])) {
+                    if (!((_d = definition.users) === null || _d === void 0 ? void 0 : _d.properties[propertyName])) {
                         report(action.type, 'contains a property that doesn’t exist in users.properties', [
                             ...path,
                             'properties',
@@ -515,14 +515,14 @@ function validateActions(definition, report) {
             if (action.type.startsWith('resource.')) {
                 // All of the actions starting with `resource.` contain a property called `resource`.
                 const { resource: resourceName, view } = action;
-                const resource = (_c = definition.resources) === null || _c === void 0 ? void 0 : _c[resourceName];
+                const resource = (_e = definition.resources) === null || _e === void 0 ? void 0 : _e[resourceName];
                 if (!resource) {
                     report(action.type, 'refers to a resource that doesn’t exist', [...path, 'resource']);
                     return;
                 }
                 if (!action.type.startsWith('resource.subscription.')) {
                     const type = action.type.split('.')[1];
-                    const roles = (_e = (_d = resource === null || resource === void 0 ? void 0 : resource[type]) === null || _d === void 0 ? void 0 : _d.roles) !== null && _e !== void 0 ? _e : resource === null || resource === void 0 ? void 0 : resource.roles;
+                    const roles = (_g = (_f = resource === null || resource === void 0 ? void 0 : resource[type]) === null || _f === void 0 ? void 0 : _f.roles) !== null && _g !== void 0 ? _g : resource === null || resource === void 0 ? void 0 : resource.roles;
                     if (!roles) {
                         report(action.type, 'refers to a resource action that is currently set to private', [
                             ...path,
@@ -535,11 +535,11 @@ function validateActions(definition, report) {
                         return;
                     }
                     if ((type === 'get' || type === 'query') && view) {
-                        if (!((_f = resource.views) === null || _f === void 0 ? void 0 : _f[view])) {
+                        if (!((_h = resource.views) === null || _h === void 0 ? void 0 : _h[view])) {
                             report(action.type, 'refers to a view that doesn’t exist', [...path, 'view']);
                             return;
                         }
-                        const viewRoles = (_g = resource === null || resource === void 0 ? void 0 : resource.views) === null || _g === void 0 ? void 0 : _g[view].roles;
+                        const viewRoles = (_j = resource === null || resource === void 0 ? void 0 : resource.views) === null || _j === void 0 ? void 0 : _j[view].roles;
                         if (!(viewRoles === null || viewRoles === void 0 ? void 0 : viewRoles.length)) {
                             report(action.type, 'refers to a resource view that is currently set to private', [
                                 ...path,
@@ -555,19 +555,19 @@ function validateActions(definition, report) {
                 }
             }
             if (action.type.startsWith('flow.')) {
-                const page = (_h = definition.pages) === null || _h === void 0 ? void 0 : _h[Number(path[1])];
+                const page = (_k = definition.pages) === null || _k === void 0 ? void 0 : _k[Number(path[1])];
                 if (page.type !== 'flow' && page.type !== 'loop') {
                     report(action.type, 'flow actions can only be used on pages with the type ‘flow’ or ‘loop’', [...path, 'type']);
                     return;
                 }
-                if (action.type === 'flow.cancel' && !((_j = page.actions) === null || _j === void 0 ? void 0 : _j.onFlowCancel)) {
+                if (action.type === 'flow.cancel' && !((_l = page.actions) === null || _l === void 0 ? void 0 : _l.onFlowCancel)) {
                     report(action.type, 'was defined but ‘onFlowCancel’ page action wasn’t defined', [
                         ...path,
                         'type',
                     ]);
                     return;
                 }
-                if (action.type === 'flow.finish' && !((_k = page.actions) === null || _k === void 0 ? void 0 : _k.onFlowFinish)) {
+                if (action.type === 'flow.finish' && !((_m = page.actions) === null || _m === void 0 ? void 0 : _m.onFlowFinish)) {
                     report(action.type, 'was defined but ‘onFlowFinish’ page action wasn’t defined', [
                         ...path,
                         'type',
@@ -581,7 +581,7 @@ function validateActions(definition, report) {
                 if (page.type === 'flow' &&
                     action.type === 'flow.next' &&
                     Number(path[3]) === page.steps.length - 1 &&
-                    !((_l = page.actions) === null || _l === void 0 ? void 0 : _l.onFlowFinish)) {
+                    !((_o = page.actions) === null || _o === void 0 ? void 0 : _o.onFlowFinish)) {
                     report(action.type, 'was defined on the last step but ‘onFlowFinish’ page action wasn’t defined', [...path, 'type']);
                     return;
                 }