@mojojs/core 0.4.7 → 0.5.3

package/lib/body.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="node" />
-/// <reference types="busboy" />
 /// <reference types="cheerio" />
 import type { JSONValue } from './types.js';
 import type { IncomingHttpHeaders, IncomingMessage } from 'http';
 import { Params } from './body/params.js';
+import Busboy from 'busboy';
 declare type BusboyFile = [string, NodeJS.ReadableStream, string, string, string];
 interface FileUpload {
     fieldname: string;
@@ -18,8 +18,8 @@ export declare class Body {
     constructor(stream: IncomingMessage);
     [Symbol.asyncIterator](): AsyncIterable<Buffer>;
     buffer(): Promise<Buffer>;
-    files(options?: busboy.BusboyConfig): AsyncIterableIterator<FileUpload>;
-    form(options?: busboy.BusboyConfig): Promise<Params>;
+    files(options?: Busboy.BusboyConfig): AsyncIterableIterator<FileUpload>;
+    form(options?: Busboy.BusboyConfig): Promise<Params>;
     get(name: string): string | undefined;
     get headers(): IncomingHttpHeaders;
     html(): Promise<cheerio.Root>;
@@ -28,8 +28,9 @@ export declare class Body {
     pipe(writer: NodeJS.WritableStream): Promise<void>;
     text(charset?: BufferEncoding): Promise<string>;
     xml(): Promise<cheerio.Root>;
+    yaml(): Promise<unknown>;
     _consumeBody(): Promise<Uint8Array[]>;
-    _formIterator(options?: busboy.BusboyConfig): AsyncIterableIterator<BusboyFile>;
+    _formIterator(options?: Busboy.BusboyConfig): AsyncIterableIterator<BusboyFile>;
     _isForm(): boolean;
     get _params(): Params;
 }

package/lib/body.js

@@ -2,6 +2,7 @@ import { on } from 'events';
 import { Params } from './body/params.js';
 import Busboy from 'busboy';
 import cheerio from 'cheerio';
+import yaml from 'js-yaml';
 export class Body {
     constructor(stream) {
         this._form = undefined;
@@ -63,6 +64,9 @@ export class Body {
     async xml() {
         return cheerio.load(await this.buffer(), { xmlMode: true });
     }
+    async yaml() {
+        return yaml.load((await this.buffer()).toString());
+    }
     async _consumeBody() {
         const chunks = [];
         return await new Promise((resolve, reject) => {

package/lib/context.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="node" />
-/// <reference types="busboy" />
 import type { App } from './app.js';
 import type { ChildLogger } from './logger.js';
 import type { Plan } from './router/plan.js';
@@ -8,6 +7,7 @@ import type { UserAgent } from './user-agent.js';
 import type { WebSocket } from './websocket.js';
 import type Path from '@mojojs/path';
 import type { ValidateFunction } from 'ajv';
+import type { BusboyConfig } from 'busboy';
 import type http from 'http';
 import EventEmitter from 'events';
 import { Params } from './body/params.js';
@@ -45,7 +45,7 @@ declare class Context extends EventEmitter {
     get isWebSocket(): boolean;
     json(fn: WebSocketHandler): this;
     get models(): Record<string, any>;
-    params(options?: busboy.BusboyConfig): Promise<Params>;
+    params(options?: BusboyConfig): Promise<Params>;
     plain(fn: WebSocketHandler): this;
     redirectTo(target: string, options?: {
         status?: number;

package/lib/core.d.ts

@@ -8,6 +8,7 @@ import { App } from './app.js';
 export declare const version: any;
 export default function mojo(options?: AppOptions): App;
 export { default as jsonConfigPlugin } from './plugins/json-config.js';
+export { default as yamlConfigPlugin } from './plugins/yaml-config.js';
 export { Logger } from './logger.js';
 export { Server } from './server.js';
 export { Session } from './session.js';

package/lib/core.js

@@ -19,6 +19,7 @@ export default function mojo(options) {
 }
 // "Professor: These old Doomsday devices are dangerously unstable. I'll rest easier not knowing where they are."
 export { default as jsonConfigPlugin } from './plugins/json-config.js';
+export { default as yamlConfigPlugin } from './plugins/yaml-config.js';
 export { Logger } from './logger.js';
 export { Server } from './server.js';
 export { Session } from './session.js';

package/lib/mime.js

@@ -2,7 +2,8 @@ import mime from 'mime-types';
 const COMMON = {
     html: 'text/html; charset=utf-8',
     json: 'application/json; charset=utf-8',
-    txt: 'text/plain; charset=utf-8'
+    txt: 'text/plain; charset=utf-8',
+    yaml: 'text/yaml; charset=utf-8'
 };
 export class Mime {
     detect(accepts) {

package/lib/plugins/yaml-config.d.ts

@@ -0,0 +1,4 @@
+import type { MojoApp } from '../types.js';
+export default function yamlConfigPlugin(app: MojoApp, options: {
+    file?: string;
+}): void;

package/lib/plugins/yaml-config.js

@@ -0,0 +1,21 @@
+import Path from '@mojojs/path';
+import yaml from 'js-yaml';
+export default function yamlConfigPlugin(app, options) {
+    const filename = new Path(options.file ?? 'config.yml');
+    const filePath = filename.isAbsolute() ? filename : app.home.child(filename.toString());
+    const log = app.log;
+    if (filePath.existsSync()) {
+        Object.assign(app.config, yaml.load(filePath.readFileSync().toString()));
+        log.trace(`Config file "${filePath.toString()}" loaded`);
+    }
+    else {
+        log.trace(`Config file "${filePath.toString()}" does not exist`);
+    }
+    const fileParts = filePath.toString().split('.');
+    fileParts.splice(-1, 0, app.mode);
+    const modeFilePath = new Path(fileParts.join('.'));
+    if (modeFilePath.existsSync()) {
+        Object.assign(app.config, yaml.load(modeFilePath.readFileSync().toString()));
+        log.trace(`Mode specific config file "${filePath.toString()}" loaded`);
+    }
+}

package/lib/renderer.js

@@ -1,4 +1,5 @@
 import Path from '@mojojs/path';
+import yaml from 'js-yaml';
 export class Renderer {
     constructor() {
         this.defaultEngine = 'ejs';
@@ -29,6 +30,10 @@ export class Renderer {
             }
             return { output: Buffer.from(JSON.stringify(options.json)), format: options.format ?? 'json' };
         }
+        if (options.yaml !== undefined) {
+            log.trace('Rendering YAML response');
+            return { output: Buffer.from(yaml.dump(options.yaml)), format: options.format ?? 'yaml' };
+        }
         if (options.engine !== undefined) {
             const engine = this.engines[options.engine];
             if (engine === undefined)

package/lib/user-agent/test.d.ts

@@ -49,6 +49,7 @@ export declare class TestUserAgent extends MockUserAgent {
     typeLike(regex: RegExp): this;
     websocketOk(url: string | URL, options?: UserAgentWebSocketOptions): Promise<void>;
     get ws(): WebSocket;
+    yamlIs(value: any): this;
     get _cheerio(): cheerio.Root;
     _prepareTap(tap: Tap.Tap): void;
     _requestOk(skip: SkipFunction, method: string, url: string | URL, options?: UserAgentRequestOptions): Promise<this>;

package/lib/user-agent/test.js

@@ -2,6 +2,7 @@ import assert from 'assert/strict';
 import { on } from 'events';
 import { MockUserAgent } from './mock.js';
 import cheerio from 'cheerio';
+import yaml from 'js-yaml';
 import StackUtils from 'stack-utils';
 export class TestUserAgent extends MockUserAgent {
     constructor(options = {}) {
@@ -141,6 +142,10 @@ export class TestUserAgent extends MockUserAgent {
             throw new Error('No active WebSocket connection');
         return ws;
     }
+    yamlIs(value) {
+        this.assert('same', [yaml.load(this.body.toString()), value], 'YAML body is equal', this.yamlIs);
+        return this;
+    }
     get _cheerio() {
         if (this._dom === undefined)
             this._dom = cheerio.load(this.body ?? '');

package/lib/user-agent.js

@@ -6,6 +6,7 @@ import { format, URL } from 'url';
 import { UserAgentResponse } from './user-agent/response.js';
 import { WebSocket } from './websocket.js';
 import FormData from 'form-data';
+import yaml from 'js-yaml';
 import tough from 'tough-cookie';
 import WS from 'ws';
 class UserAgent extends EventEmitter {
@@ -100,6 +101,11 @@ class UserAgent extends EventEmitter {
                 filtered.headers['Content-Type'] = 'application/json';
             filtered.body = JSON.stringify(filtered.json);
         }
+        else if (filtered.yaml !== undefined) {
+            if (filtered.headers['Content-Type'] === undefined)
+                filtered.headers['Content-Type'] = 'text/yaml';
+            filtered.body = yaml.dump(filtered.yaml);
+        }
         else if (filtered.form !== undefined) {
             if (filtered.headers['Content-Type'] === undefined) {
                 filtered.headers['Content-Type'] = 'application/x-www-form-urlencoded';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojojs/core",
-  "version": "0.4.7",
+  "version": "0.5.3",
   "description": "Real-time web framework",
   "keywords": [
     "web",
@@ -25,7 +25,7 @@
     "build:lint": "npm run build && npm run lint",
     "build:test": "npm run build && npm test",
     "build:watch": "npm run build -- --watch",
-    "clean": "rm -r tsconfig.tsbuildinfo test/support/ts/full-app/tsconfig.tsbuildinfo lib test/support/ts/full-app/lib",
+    "clean": "rm -rf tsconfig.tsbuildinfo test/support/ts/full-app/tsconfig.tsbuildinfo lib test/support/ts/full-app/lib",
     "coverage": "tap --node-arg='--no-warnings' --node-arg='--experimental-loader' --node-arg='@istanbuljs/esm-loader-hook' test/*.js",
     "coverage:ci": "npm run coverage -- --no-check-coverage && tap --no-check-coverage --coverage-report=text-lcov > .lcov.info",
     "lint": "eslint \"test/*.js\" \"test/support/js/**/*.js\" \"test/support/ts/**/src/**/*.ts\" \"src/**/*.ts\" \"src/*.ts\"",
@@ -49,10 +49,11 @@
   },
   "devDependencies": {
     "@istanbuljs/esm-loader-hook": "^=0.1.2",
-    "@types/busboy": "^0.2.3",
+    "@types/busboy": "^0.3.1",
     "@types/cheerio": "^0.22.29",
     "@types/cookie": "^0.4.0",
     "@types/ejs": "^3.0.6",
+    "@types/js-yaml": "^4.0.3",
     "@types/lru-cache": "^5.1.0",
     "@types/mime-types": "^2.1.0",
     "@types/node": "^16.0.0",
@@ -61,16 +62,15 @@
     "@types/tap": "^15.0.3",
     "@types/tough-cookie": "^4.0.0",
     "@types/ws": "^7.4.5",
-    "@typescript-eslint/eslint-plugin": "^4.27.0",
+    "@typescript-eslint/eslint-plugin": "^5.1.0",
     "autocannon": "^7.3.0",
     "concurrently": "^6.2.0",
-    "eslint": "^7.28.0",
+    "eslint": "^8.1.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.23.4",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.4.0",
-    "eslint-plugin-promise": "^5.1.0",
-    "prettier": "2.3.2",
+    "eslint-plugin-prettier": "^4.0.0",
+    "prettier": "2.4.1",
     "typescript": "^=4.3.2"
   },
   "engines": {
@@ -86,6 +86,7 @@
     "ejs": "^3.1.6",
     "escape-string-regexp": "^5.0.0",
     "form-data": "^4.0.0",
+    "js-yaml": "^4.1.0",
     "lru-cache": "^6.0.0",
     "mime-types": "^2.1.30",
     "nopt": "^5.0.0",