@appsemble/node-utils/parsers.js

NodeJS utilities used by Appsemble internally.

import { randomUUID } from 'node:crypto';
import { createWriteStream } from 'node:fs';
import { tmpdir } from 'node:os';
import { join } from 'node:path';
import { parse } from 'node:querystring';
import { finished } from 'node:stream/promises';
import busboy from 'busboy';
import { parse as parseCSV } from 'csv-parse';
import { bufferParser } from 'koas-body-parser';
import { SchemaValidationError } from 'koas-core';
import { is } from 'type-is';
import { logger } from './logger.js';
import { TempFile } from './server/types.js';
export const xWwwFormUrlencodedParser = async (body, mediaTypeObject, options, ctx) => {
    const buffer = await bufferParser(body, mediaTypeObject, options, ctx);
    return parse(String(buffer));
};
export const csvParser = (body, mediaTypeObject, options, ctx) => new Promise((resolve, reject) => {
    body.pipe(parseCSV({
        bom: true,
        columns: true,
        delimiter: ctx.queryParams?.delimiter?.replace(/\\t/g, '\t') ?? ',',
    }, (error, records) => {
        if (error) {
            reject(error);
        }
        else {
            resolve(records);
        }
    }));
});
/**
 * Parse a raw string value based on a JSON schema.
 *
 * @param schema The JSON schema whose type to use for parsing the value.
 * @param content The value to parse.
 * @returns The parsed value.
 */
function fromString(schema, content) {
    switch (schema?.type) {
        case 'integer':
        case 'number':
            return Number(content);
        case 'boolean':
            if (content === 'true') {
                return true;
            }
            if (content === 'false') {
                return false;
            }
            return content;
        case 'object':
            try {
                return JSON.parse(content);
            }
            catch {
                return content;
            }
        default:
            return content;
    }
}
// Taken from https://gitlab.com/remcohaszing/koas/-/blob/main/packages/koas-body-parser/src/parsers/formdata.ts
// Files are passed as streams rather than buffers
export const streamParser = async (body, mediaTypeObject, { resolveRef }, ctx) => {
    const bb = busboy({ headers: ctx.req.headers });
    const { encoding = {}, schema } = mediaTypeObject || {};
    const { properties = {} } = resolveRef(schema) || {};
    const response = {};
    const tempFiles = {};
    const fileWrites = [];
    await new Promise((resolve, reject) => {
        function onError(error) {
            bb.removeAllListeners();
            logger.error(error);
            reject(error);
        }
        bb.on('file', (fieldName, stream, { filename, mimeType: mime }) => {
            const propertySchema = resolveRef(properties[fieldName]);
            const path = join(tmpdir(), `${Date.now()}-${randomUUID()}`);
            try {
                const fileWriteStream = createWriteStream(path);
                fileWrites.push(finished(fileWriteStream));
                stream.pipe(fileWriteStream);
                stream.on('error', onError);
                fileWriteStream.on('error', onError);
            }
            catch (error) {
                onError(error);
            }
            if (propertySchema && propertySchema.type === 'array') {
                if (!Object.hasOwnProperty.call(response, fieldName)) {
                    response[fieldName] = [];
                }
                if (!Object.hasOwnProperty.call(tempFiles, fieldName)) {
                    tempFiles[fieldName] = [];
                }
                response[fieldName].push('');
                tempFiles[fieldName].push(new TempFile({ path, mime, filename }));
            }
            else {
                response[fieldName] = '';
                tempFiles[fieldName] = new TempFile({ path, mime, filename });
            }
        })
            .on('field', (fieldName, content) => {
            const propertySchema = resolveRef(properties[fieldName]);
            if (propertySchema && propertySchema.type === 'array') {
                if (!Object.hasOwnProperty.call(response, fieldName)) {
                    response[fieldName] = [];
                }
                response[fieldName].push(fromString(resolveRef(propertySchema.items), content));
            }
            else {
                response[fieldName] = fromString(propertySchema, content);
            }
        })
            .on('close', async () => {
            bb.removeAllListeners();
            try {
                await Promise.all(fileWrites);
                resolve();
            }
            catch (error) {
                reject(error);
            }
        })
            .on('error', onError)
            .on('partsLimit', onError)
            .on('filesLimit', onError)
            .on('fieldsLimit', onError);
        ctx.req.pipe(bb);
    });
    // @ts-expect-error 2345 argument of type is not assignable to parameter of type
    // (strictNullChecks) (schema may be undefined for some reason)
    const result = ctx.openApi.validate(response, schema, { throw: false });
    for (const [key, values] of Object.entries(tempFiles)) {
        const vals = Array.isArray(values) ? values : [values];
        for (const [index, value] of vals.entries()) {
            if (!encoding?.[key]?.contentType) {
                continue;
            }
            if (!is(value.mime, encoding[key].contentType.split(',').map((contentType) => contentType.trim()))) {
                const error = result.addError({
                    name: 'contentType',
                    argument: encoding[key].contentType,
                    message: 'has an invalid content type',
                });
                error.schema = {};
                error.path = values === value ? [key] : [key, index];
                error.property = values === value ? `instance.${key}` : `instance.${key}[${index}]`;
            }
        }
    }
    if (!result.valid) {
        throw new SchemaValidationError('Invalid content types found', { result });
    }
    return Object.assign(response, tempFiles);
};
streamParser.skipValidation = true;
//# sourceMappingURL=parsers.js.map