@appsemble/utils 0.29.7 → 0.29.9

package/README.md

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

package/api/components/schemas/SecurityDefaultDefinition.js

@@ -14,7 +14,7 @@ The following values are allowed:
 - \`organization\`: Every authenticated user gets the default role if they are in the same organization as the app.
 - \`invite\`: The user has to manually get a role assigned.
 
-> **Important**: When [OAuth2](../02-guides/oauth2) or [SAML2.0](../02-guides/saml) is used in the
+> **Important**: When [OAuth2](../guides/oauth2) or [SAML2.0](../guides/saml) is used in the
 > app, you must set the policy to \`everyone\`. This will specifically allow every configured
 > authentication method on the secrets page to be used as login method. If you do not want other
 > Appsemble user accounts to be able to log in, you must \`disable\` the \`appsemble login\` options

package/api/paths/assets.js

@@ -187,6 +187,16 @@ export const paths = {
                 },
             },
         },
+        head: {
+            tags: ['asset'],
+            description: 'Get the headers for a single asset',
+            operationId: 'getAssetHeadersById',
+            responses: {
+                200: {
+                    description: 'The asset that matches the given id.',
+                },
+            },
+        },
         delete: {
             tags: ['asset'],
             description: 'Remove an existing asset',

package/assets.d.ts

@@ -0,0 +1,29 @@
+import { type IconName } from '@fortawesome/fontawesome-common-types';
+export declare enum MimeTypeCategory {
+    Image = "image",
+    Video = "video",
+    PDF = "pdf",
+    Wordprocessing = "wordprocessing",
+    Spreadsheet = "spreadsheet",
+    Presentation = "presentation",
+    Archive = "archive"
+}
+/**
+ * Puts a mimetype into one of the predefined categories.
+ *
+ * Wildcard behavior is supported.
+ *
+ * @param mimeType A mimetype to categorize
+ * @returns A category that the mimetype falls into or null if no category is found
+ */
+export declare function getMimeTypeCategory(mimeType: string): MimeTypeCategory | null;
+export declare function getMimeTypeCategories(mimeTypes: string[]): MimeTypeCategory[];
+export type FileIconName = IconName | `file-${string}`;
+export declare function getMimeTypeIcon(category: MimeTypeCategory): FileIconName;
+/**
+ * Extracts the filename from a Content-Disposition header string.
+ *
+ * @param contentDisposition The Content-Disposition header string
+ * @returns The name of the file or null if it's not present
+ */
+export declare function getFilenameFromContentDisposition(contentDisposition: string): string | null;

package/assets.js

@@ -0,0 +1,81 @@
+export var MimeTypeCategory;
+(function (MimeTypeCategory) {
+    MimeTypeCategory["Image"] = "image";
+    MimeTypeCategory["Video"] = "video";
+    MimeTypeCategory["PDF"] = "pdf";
+    MimeTypeCategory["Wordprocessing"] = "wordprocessing";
+    MimeTypeCategory["Spreadsheet"] = "spreadsheet";
+    MimeTypeCategory["Presentation"] = "presentation";
+    MimeTypeCategory["Archive"] = "archive";
+})(MimeTypeCategory || (MimeTypeCategory = {}));
+const mimeTypeCategories = {
+    [MimeTypeCategory.Image]: ['image/jpeg', 'image/png', 'image/gif', 'image/*'],
+    [MimeTypeCategory.Video]: ['video/mp4', 'video/webm', 'video/ogg', 'video/*'],
+    [MimeTypeCategory.PDF]: ['application/pdf'],
+    [MimeTypeCategory.Wordprocessing]: [
+        'application/msword',
+        'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+    ],
+    [MimeTypeCategory.Spreadsheet]: [
+        'application/vnd.ms-excel',
+        'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+    ],
+    [MimeTypeCategory.Presentation]: [
+        'application/vnd.ms-powerpoint',
+        'application/vnd.openxmlformats-officedocument.presentationml.presentation',
+    ],
+    [MimeTypeCategory.Archive]: ['application/zip'],
+};
+/**
+ * Puts a mimetype into one of the predefined categories.
+ *
+ * Wildcard behavior is supported.
+ *
+ * @param mimeType A mimetype to categorize
+ * @returns A category that the mimetype falls into or null if no category is found
+ */
+export function getMimeTypeCategory(mimeType) {
+    var _a;
+    const [mimeBaseType, mimeSubType] = mimeType.split('/');
+    const [category] = (_a = Object.entries(mimeTypeCategories).find(([, types]) => types.some((type) => {
+        const [baseType, subType] = type.split('/');
+        return baseType === mimeBaseType && (subType === '*' || subType === mimeSubType);
+    }))) !== null && _a !== void 0 ? _a : [null];
+    return category;
+}
+export function getMimeTypeCategories(mimeTypes) {
+    return Array.from(new Set(mimeTypes.map(getMimeTypeCategory).filter(Boolean)));
+}
+export function getMimeTypeIcon(category) {
+    switch (category) {
+        case MimeTypeCategory.Image:
+        case MimeTypeCategory.Video:
+        case MimeTypeCategory.PDF:
+            return `file-${category}`;
+        case MimeTypeCategory.Wordprocessing:
+            return 'file-word';
+        case MimeTypeCategory.Spreadsheet:
+            return 'file-excel';
+        case MimeTypeCategory.Presentation:
+            return 'file-powerpoint';
+        case MimeTypeCategory.Archive:
+            return 'file-zipper';
+        default:
+            return 'file';
+    }
+}
+/**
+ * Extracts the filename from a Content-Disposition header string.
+ *
+ * @param contentDisposition The Content-Disposition header string
+ * @returns The name of the file or null if it's not present
+ */
+export function getFilenameFromContentDisposition(contentDisposition) {
+    const filenameRegex = /filename="([^"]+)"/;
+    const matches = filenameRegex.exec(contentDisposition);
+    if (matches != null && matches[1]) {
+        return matches[1].replaceAll(/["']/g, '');
+    }
+    return null;
+}
+//# sourceMappingURL=assets.js.map

package/index.d.ts

@@ -29,3 +29,5 @@ export * from './serverActions.js';
 export * from './validation.js';
 export * from './serializeResource.js';
 export * from './convertToCsv.js';
+export * from './assets.js';
+export * from './validateAppMessages.js';

package/index.js

@@ -29,4 +29,6 @@ export * from './serverActions.js';
 export * from './validation.js';
 export * from './serializeResource.js';
 export * from './convertToCsv.js';
+export * from './assets.js';
+export * from './validateAppMessages.js';
 //# sourceMappingURL=index.js.map

package/package.json

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

package/reference-schemas/remappers/data.js

@@ -61,7 +61,7 @@ Clicking on the first item would log \`0\`, the second item \`1\` and so on.
     },
     history: {
         type: 'integer',
-        description: `> **Note:** This remapper is explained more in depth in the [History](/docs/04-remappers/05-history) page
+        description: `> **Note:** This remapper is explained more in depth in the [History](/docs/remappers/history) page
 
 Gives the data at the history entry at the specified history index. The history at specified index
 is the data that is passed to that action.
@@ -166,7 +166,7 @@ Example:
 \`\`\`
 
 The page data only works in the context of a flow page. Let’s say you have a
-[“FlowPage”](/docs/05-reference/app#-flow-page-definition) type with multiple subpages. Whenever you
+[“FlowPage”](/docs/reference/app#-flow-page-definition) type with multiple subpages. Whenever you
 navigate to the next page it adds the data from that page to the flow page’s data. The page remapper
 allows you to access this cumulative data.
 
@@ -281,7 +281,7 @@ ${schemaExample('static', { exclude: ['input'] })}
     },
     translate: {
         type: 'string',
-        description: `> **Note:** This is explained much more in depth at [Translating](/docs/02-guides/translating)
+        description: `> **Note:** This is explained much more in depth at [Translating](/docs/guides/translating)
 
 This remapper allows you to easily add translations to your app. To make this remapper work, replace
 any static text with \`translate: {name}\`. Then, in your app’s Translations page pick the language

package/reference-schemas/remappers/unsorted.js

@@ -2,7 +2,7 @@ export const unsortedRemappers = {
     ics: {
         type: 'object',
         description: `Create a calendar event. This event can be downloaded as an \`.ics\` file and
-uploaded to your agenda using the [download](../05-reference/action#download) action.
+uploaded to your agenda using the [download](../reference/action#download) action.
 
 For example, the following input:
 \`\`\`yaml
@@ -160,12 +160,12 @@ The options represent the level of logging that will show in the console.
   - \`appId\`: ID of the application,
   - \`url\`: Absolute URL of the page where the remapper was fired,
   - \`appUrl\`: Base URL of the application,
-  - \`pageData\`: Current page data of a FlowPage (See [page remapper](./04-data#page)),
-  - \`userInfo\`: User's information if they are logged in (See [user remapper](./04-data#user)),
+  - \`pageData\`: Current page data of a FlowPage (See [page remapper](./data#page)),
+  - \`userInfo\`: User's information if they are logged in (See [user remapper](./data#user)),
   - \`context\`: Internal context
-  - \`history\`: Complete list of this remapper’s history (See [history remapper](./05-history))
+  - \`history\`: Complete list of this remapper’s history (See [history remapper](./history))
   - \`locale\`: The user’s locale,
-  - \`stepRef\`: In a loop page, gives the properties from the loop’s current data index (See [step remapper](./04-data#step))
+  - \`stepRef\`: In a loop page, gives the properties from the loop’s current data index (See [step remapper](./data#step))
 
 For example:
 

package/validateAppMessages.d.ts

@@ -0,0 +1,5 @@
+import { type AppDefinition, type AppsembleMessages } from '@appsemble/types';
+export declare class AppMessageValidationError extends Error {
+    constructor(message: string);
+}
+export declare function validateMessages(messages: AppsembleMessages, app: AppDefinition): void;

package/validateAppMessages.js

@@ -0,0 +1,71 @@
+import { extractAppMessages } from './appMessages.js';
+import { normalizeBlockName } from './blockUtils.js';
+import { has } from './has.js';
+export class AppMessageValidationError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'AppMessageValidationError';
+    }
+}
+export function validateMessages(messages, app) {
+    var _a, _b;
+    const blockMessageKeys = {};
+    const extractedMessages = extractAppMessages(app, (block) => {
+        const type = normalizeBlockName(block.type);
+        if (blockMessageKeys[type]) {
+            blockMessageKeys[type][block.version] = {};
+        }
+        else {
+            blockMessageKeys[type] = {
+                [block.version]: {},
+            };
+        }
+    });
+    if (messages.messageIds) {
+        Object.keys(messages.messageIds).map((key) => {
+            if (typeof messages.messageIds[key] !== 'string') {
+                throw new AppMessageValidationError(`Not allowed to have non-string message ${messages.messageIds[key]}`);
+            }
+        });
+    }
+    if (messages.app) {
+        Object.keys(messages.app).map((key) => {
+            const match = /^(pages\.[\dA-Za-z-]+(\..+)?)\.blocks\.\d+.+/.exec(key);
+            if ((!has(extractedMessages === null || extractedMessages === void 0 ? void 0 : extractedMessages.app, key) || typeof messages.app[key] !== 'string') && !match) {
+                throw new AppMessageValidationError(`Invalid key ${key}`);
+            }
+        });
+    }
+    const blockMessages = {};
+    if (messages.blocks) {
+        for (const key of Object.keys(messages.blocks)) {
+            if (!has(blockMessageKeys, key)) {
+                throw new AppMessageValidationError(`Invalid translation key: blocks.${key}\nThis block is not used in the app`);
+            }
+        }
+    }
+    const coreMessages = (_a = messages.core) !== null && _a !== void 0 ? _a : {};
+    for (const [key, value] of Object.entries(coreMessages)) {
+        if (!value || typeof value !== 'string') {
+            throw new AppMessageValidationError(`Invalid translation key: core.${key}`);
+        }
+    }
+    for (const [blockName] of Object.entries(blockMessageKeys)) {
+        if ((_b = messages.blocks) === null || _b === void 0 ? void 0 : _b[blockName]) {
+            blockMessages[blockName] = {};
+            for (const [version, oldValues] of Object.entries(messages.blocks[blockName])) {
+                if (!has(blockMessageKeys[blockName], version)) {
+                    throw new AppMessageValidationError(`Invalid translation key: blocks.${blockName}.${version}
+This block version is not used in the app`);
+                }
+                for (const [oldValueKey, oldValue] of Object.entries(messages.blocks[blockName][version])) {
+                    if (typeof oldValue !== 'string') {
+                        throw new AppMessageValidationError(`Invalid translation key: blocks.${blockName}.${version}.${oldValueKey}`);
+                    }
+                    blockMessages[blockName][version] = oldValues;
+                }
+            }
+        }
+    }
+}
+//# sourceMappingURL=validateAppMessages.js.map