@sealcode/sealgen 0.4.2 → 0.5.2

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sealcode/sealgen",
-	"version": "0.4.2",
+	"version": "0.5.2",
 	"description": "Module to automate adding routes and collections to a sealious application",
 	"main": "lib/index.js",
 	"scripts": {
@@ -18,6 +18,7 @@
 	"devDependencies": {
 		"@types/koa__router": "^8.0.4",
 		"@types/mocha": "^9.0.0",
+		"@types/prettier": "^2.7.0",
 		"@types/prompts": "^2.0.14",
 		"@typescript-eslint/eslint-plugin": "^4.29.3",
 		"@typescript-eslint/parser": "^4.29.3",
@@ -28,7 +29,7 @@
 		"mocha": "^9.1.1",
 		"mri": "^1.1.6",
 		"nyc": "^15.1.0",
-		"prettier": "^2.3.2",
+		"prettier": "^2.7.1",
 		"source-map-support": "^0.5.19",
 		"ts-node": "^10.2.1",
 		"typescript": "^4.3.5"
@@ -37,7 +38,7 @@
 	"dependencies": {
 		"@koa/router": "^10.1.1",
 		"@sealcode/ts-predicates": "^0.4.0",
-		"esbuild": "^0.14.54",
+		"esbuild": "^0.15.5",
 		"esbuild-sass-plugin": "^2.3.1",
 		"koa": "^2.13.0",
 		"locreq": "^2.0.2",

package/src/build.ts

@@ -19,7 +19,7 @@ async function build_ts() {
 		outdir: "./dist/back",
 		logLevel: "info",
 		platform: "node",
-		target: "node16",
+		target: "es2022",
 		format: "cjs",
 	});
 }
@@ -48,7 +48,8 @@ async function complex_build(watch: boolean): Promise<void> {
 			if (
 				path.endsWith(".ts") &&
 				!path.endsWith("src/back/collections.ts") &&
-				!path.endsWith("src/back/routes/routes.ts")
+				!path.endsWith("src/back/routes/routes.ts") &&
+				!path.endsWith("src/back/routes/urls.ts")
 			) {
 				await build_ts();
 				console.log(`Finished TS build [on ${path}]`);

package/src/forms/controls/checkboxed-list-input.ts

@@ -1,5 +1,5 @@
 import { is, predicates } from "@sealcode/ts-predicates";
-import { BaseContext } from "koa";
+import { Context } from "koa";
 import { tempstream } from "tempstream";
 import { ChekboxedListField } from "../fields/field";
 import { FormDataValue } from "../form";
@@ -13,7 +13,7 @@ export class CheckboxedListInput extends FormFieldControl {
 		super([field]);
 	}
 
-	async render(ctx: BaseContext, data: Record<string, FormDataValue>) {
+	async render(ctx: Context, data: Record<string, FormDataValue>) {
 		const { parsed: pickedValues } = await this.field.getValue(ctx, data);
 		if (!is(pickedValues, predicates.array(predicates.string))) {
 			throw new Error("picked values is not an array of strings");

package/src/forms/controls/controls.ts

@@ -7,3 +7,4 @@ export { Dropdown } from "./dropdown";
 export { SimpleInput } from "./simple-input";
 export { FormHeader } from "./form-header";
 export { FormParagraph } from "./form-paragraph";
+export { HTML } from "./html";

package/src/forms/controls/dropdown.ts

@@ -1,4 +1,4 @@
-import { BaseContext } from "koa";
+import { Context } from "koa";
 import { tempstream } from "tempstream";
 import { FormField, PickFromListField } from "../fields/field";
 import { FormDataValue } from "../form";
@@ -21,7 +21,7 @@ export class Dropdown extends FormFieldControl {
 	}
 
 	async render<Fields extends Record<string, FormField>>(
-		ctx: BaseContext,
+		ctx: Context,
 		data: Record<string, FormDataValue>
 	) {
 		const { parsed: picked_value } = await this.field.getValue(ctx, data);

package/src/forms/controls/editable-collection-subset.ts

@@ -1,4 +1,4 @@
-import { BaseContext } from "koa";
+import { Context } from "koa";
 import { FlatTemplatable, tempstream } from "tempstream";
 import { PickFromListField } from "../fields/field";
 import { FormDataValue } from "../form";
@@ -22,7 +22,7 @@ export class EditableCollectionSubset extends FormFieldControl {
 	}
 
 	async render(
-		ctx: BaseContext,
+		ctx: Context,
 		data: Record<string, FormDataValue>
 	): Promise<FlatTemplatable> {
 		const { parsed: values } = await this.field.getValue(ctx, data);

package/src/forms/controls/form-control.ts

@@ -1,10 +1,10 @@
-import { BaseContext } from "koa";
+import { Context } from "koa";
 import { FlatTemplatable } from "tempstream";
 import { FormDataValue, FormMessage } from "../form";
 
 export abstract class FormControl {
 	abstract render(
-		ctx: BaseContext,
+		ctx: Context,
 		data: Record<string, FormDataValue>,
 		messages: FormMessage[]
 	): FlatTemplatable | Promise<FlatTemplatable>;

package/src/forms/controls/form-field-control.ts

@@ -1,4 +1,4 @@
-import { BaseContext } from "koa";
+import { Context } from "koa";
 import { FlatTemplatable } from "tempstream";
 import { FormField } from "../fields/field";
 import { FieldValueType, FormDataValue } from "../form";
@@ -17,7 +17,7 @@ export abstract class FormFieldControl extends FormControl {
 	}
 
 	abstract render(
-		ctx: BaseContext,
+		ctx: Context,
 		data: Record<string, FormDataValue>
 	): FlatTemplatable | Promise<FlatTemplatable>;
 }

package/src/forms/controls/form-header.ts

@@ -1,15 +1,15 @@
-import { BaseContext } from "koa";
+import { Context } from "koa";
 import { FormControl } from "./controls";
 
 export class FormHeader extends FormControl {
 	role = <const>"decoration";
 	constructor(
 		public text: string,
-		public isVisible: (ctx: BaseContext) => Promise<boolean> = async () => true
+		public isVisible: (ctx: Context) => Promise<boolean> = async () => true
 	) {
 		super();
 	}
-	async render(ctx: BaseContext) {
+	async render(ctx: Context) {
 		const isVsbl = await this.isVisible(ctx);
 		return isVsbl ? `<h2>${this.text}</h2>` : "";
 	}

package/src/forms/controls/html.ts

@@ -0,0 +1,18 @@
+import { Context } from "koa";
+import { FlatTemplatable } from "tempstream";
+import { FormControl } from "./controls";
+
+export class HTML extends FormControl {
+	role = <const>"decoration";
+
+	constructor(public renderer: ((ctx: Context) => FlatTemplatable) | string) {
+		super();
+	}
+
+	async render(ctx: Context): Promise<FlatTemplatable> {
+		if (typeof this.renderer === "string") {
+			return this.renderer;
+		}
+		return this.renderer(ctx);
+	}
+}

package/src/forms/controls/simple-input.ts

@@ -1,7 +1,5 @@
-import { BaseContext } from "koa";
+import { Context } from "koa";
 import { FormField } from "../fields/field";
-import { NumberField } from "../fields/number";
-import { SimpleFormField } from "../fields/simple-form-field";
 import { FormDataValue } from "../form";
 import { FormFieldControl } from "./controls";
 
@@ -12,6 +10,7 @@ export class SimpleInput extends FormFieldControl {
 			id?: string;
 			label?: string;
 			autocomplete?: boolean;
+			hide_errors?: boolean;
 			type?:
 				| "color"
 				| "date"
@@ -36,7 +35,7 @@ export class SimpleInput extends FormFieldControl {
 	}
 
 	async render<Fields extends Record<string, FormField>>(
-		ctx: BaseContext,
+		ctx: Context,
 		data: Record<string, FormDataValue>
 	) {
 		const id = this.options.id || this.field.name;
@@ -70,7 +69,9 @@ export class SimpleInput extends FormFieldControl {
 				${!this.options.autocomplete ? `autocomplete="off"` : ""}
 				${this.options.step ? `step="${this.options.step}"` : ""}
 			/>
-			${~valid ? `<div class="input__error">${message}</div>` : ""}
+			${~valid && !this.options.hide_errors
+				? `<div class="input__error">${message}</div>`
+				: ""}
 		</div>`;
 	}
 }

package/src/forms/fields/checkboxed-list.ts

@@ -1,5 +1,5 @@
 import { is, predicates } from "@sealcode/ts-predicates";
-import { BaseContext } from "koa";
+import { Context } from "koa";
 import { FormDataValue } from "../form";
 import {
 	FieldParseResult,
@@ -11,16 +11,16 @@ export class ChekboxedListField extends FormField<Record<string, "on">> {
 	constructor(
 		public required: boolean = false,
 		public generateOptions: (
-			ctx: BaseContext
+			ctx: Context
 		) => Promise<Record<string, string> | { [i: string]: string }>,
-		public isVisible: (ctx: BaseContext) => Promise<boolean> = () =>
+		public isVisible: (ctx: Context) => Promise<boolean> = () =>
 			Promise.resolve(true)
 	) {
 		super(required);
 	}
 
 	public async isValueValid(
-		_: BaseContext,
+		_: Context,
 		value: unknown
 	): Promise<FormFieldValidationResponse> {
 		if (is(value, predicates.string)) {
@@ -33,7 +33,7 @@ export class ChekboxedListField extends FormField<Record<string, "on">> {
 	}
 
 	async parse(
-		_: BaseContext,
+		_: Context,
 		raw_value: FormDataValue
 	): Promise<FieldParseResult<Record<string, "on">>> {
 		if (is(raw_value, predicates.object)) {

package/src/forms/fields/collection-field.ts

@@ -1,4 +1,4 @@
-import { BaseContext } from "koa";
+import { Context } from "koa";
 import { Depromisify, Field, FieldOutput } from "sealious";
 import { FormDataValue } from "../form";
 
@@ -16,7 +16,7 @@ export class CollectionField<F extends Field> extends FormField<
 	}
 
 	async parse(
-		ctx: BaseContext,
+		ctx: Context,
 		raw_value: FormDataValue
 	): Promise<FieldParseResult<FieldOutput<F>>> {
 		const encoded_value = (await this.sealiousField.encode(
@@ -37,7 +37,7 @@ export class CollectionField<F extends Field> extends FormField<
 	}
 
 	public async isValueValid(
-		ctx: BaseContext,
+		ctx: Context,
 		value: FieldOutput<F>
 	): Promise<FormFieldValidationResponse> {
 		const { valid, reason } = await this.sealiousField.checkValue(

package/src/forms/fields/field.ts

@@ -1,11 +1,11 @@
-import { BaseContext } from "koa";
+import { Context } from "koa";
 import { t } from "../../utils/translate";
 import { FormDataValue } from "../form";
 
 export type FormFieldValidationResponse = { valid: boolean; message: string };
 
 export type FormFieldValidationFn<ValueType> = (
-	ctx: BaseContext,
+	ctx: Context,
 	value: ValueType,
 	field: FormField<ValueType>
 ) => Promise<FormFieldValidationResponse>;
@@ -29,7 +29,7 @@ export abstract class FormField<ParsedValue extends unknown = unknown> {
 	}
 
 	public async _validate(
-		ctx: BaseContext,
+		ctx: Context,
 		value: ParsedValue
 	): Promise<FormFieldValidationResponse> {
 		if (
@@ -53,19 +53,19 @@ export abstract class FormField<ParsedValue extends unknown = unknown> {
 	public abstract getEmptyValue(): ParsedValue;
 
 	public async isValueValid(
-		ctx: BaseContext,
+		ctx: Context,
 		value: ParsedValue
 	): Promise<FormFieldValidationResponse> {
 		return { valid: true, message: "" };
 	}
 
 	abstract parse(
-		ctx: BaseContext,
+		ctx: Context,
 		raw_value: FormDataValue
 	): Promise<FieldParseResult<ParsedValue>>;
 
 	async getValue(
-		ctx: BaseContext,
+		ctx: Context,
 		all_form_values: Record<string, FormDataValue>
 	): Promise<{
 		valid: boolean;

package/src/forms/fields/number.ts

@@ -1,5 +1,5 @@
 import { is, predicates } from "@sealcode/ts-predicates";
-import { BaseContext } from "koa";
+import { Context } from "koa";
 import { FormDataValue } from "../form";
 import { FieldParseResult, FormField } from "./field";
 
@@ -10,7 +10,7 @@ export class NumberField<
 		super(required);
 	}
 
-	public async isValueValid(_: BaseContext, value: unknown) {
+	public async isValueValid(_: Context, value: unknown) {
 		if (
 			(is(value, predicates.string) &&
 				!isNaN(parseFloat(value)) &&
@@ -24,7 +24,7 @@ export class NumberField<
 	}
 
 	async parse(
-		_: BaseContext,
+		_: Context,
 		value: FormDataValue
 	): Promise<FieldParseResult<number>> {
 		if (

package/src/forms/fields/pick-from-list.ts

@@ -1,5 +1,5 @@
 import { is, predicates } from "@sealcode/ts-predicates";
-import { BaseContext } from "koa";
+import { Context } from "koa";
 import { FormFieldValidationResponse } from "./field";
 import { SimpleFormField } from "./simple-form-field";
 
@@ -7,10 +7,10 @@ export class PickFromListField extends SimpleFormField {
 	constructor(
 		public required: boolean = false,
 		public generateOptions: (
-			ctx: BaseContext
+			ctx: Context
 		) => Promise<Record<string, string> | { [i: string]: string }>,
 		public customValidation: (
-			ctx: BaseContext,
+			ctx: Context,
 			value: unknown,
 			instance: PickFromListField
 		) => Promise<FormFieldValidationResponse> = (ctx, value, instance) =>
@@ -20,14 +20,14 @@ export class PickFromListField extends SimpleFormField {
 	}
 
 	public isValueValid(
-		ctx: BaseContext,
+		ctx: Context,
 		value: string
 	): Promise<FormFieldValidationResponse> {
 		return this.customValidation(ctx, value, this);
 	}
 
 	async valueInList(
-		ctx: BaseContext,
+		ctx: Context,
 		value: unknown
 	): Promise<FormFieldValidationResponse> {
 		const options = await this.generateOptions(ctx);

package/src/forms/fields/simple-form-field.ts

@@ -1,10 +1,10 @@
 import { FieldParseResult, FormField } from "./field";
 import { FormDataValue } from "../form";
-import { BaseContext } from "koa";
+import { Context } from "koa";
 
 export class SimpleFormField extends FormField<string | null> {
 	async parse(
-		_: BaseContext,
+		_: Context,
 		raw_value: FormDataValue
 	): Promise<FieldParseResult<string>> {
 		return {

package/src/forms/form.ts

@@ -1,4 +1,4 @@
-import { BaseContext } from "koa";
+import { Context } from "koa";
 import Router from "@koa/router";
 import { FlatTemplatable, Templatable, tempstream } from "tempstream";
 import {
@@ -36,19 +36,19 @@ export abstract class Form<F extends Fields> extends Mountable<F> {
 
 	async canAccess(
 		// eslint-disable-next-line @typescript-eslint/no-unused-vars
-		_: BaseContext
+		_: Context
 	): Promise<{ canAccess: boolean; message: string }> {
 		return { canAccess: true, message: "" };
 	}
 
 	async renderError(
-		_: BaseContext,
+		_: Context,
 		error: PageErrorMessage
 	): Promise<FlatTemplatable> {
 		return tempstream/* HTML */ `<div>${error.message}</div>`;
 	}
 
-	async render(ctx: BaseContext, data: FormData): Promise<FlatTemplatable> {
+	async render(ctx: Context, data: FormData): Promise<FlatTemplatable> {
 		return tempstream/* HTML */ `${this.makeFormTag()} ${
 			!this.controls.some((control) => control.role == "messages")
 				? this.renderMessages(ctx, data)
@@ -63,7 +63,7 @@ export abstract class Form<F extends Fields> extends Mountable<F> {
 	}
 
 	public async onValuesInvalid(
-		ctx: BaseContext,
+		ctx: Context,
 		form_messages: FormMessage[]
 	): Promise<void> {
 		ctx.status = 422;
@@ -77,7 +77,7 @@ export abstract class Form<F extends Fields> extends Mountable<F> {
 	}
 
 	public async onError(
-		ctx: BaseContext,
+		ctx: Context,
 		data: FormData,
 		error: unknown
 	): Promise<void> {
@@ -96,11 +96,11 @@ export abstract class Form<F extends Fields> extends Mountable<F> {
 	}
 
 	public abstract onSubmit(
-		ctx: BaseContext,
+		ctx: Context,
 		data: FormData
 	): void | Promise<void>;
 
-	public async onSuccess(ctx: BaseContext, data: FormData): Promise<void> {
+	public async onSuccess(ctx: Context, data: FormData): Promise<void> {
 		ctx.body = await this.render(ctx, {
 			raw_values: data.raw_values,
 			messages: [{ type: "success", text: this.defaultSuccessMessage }],
@@ -171,7 +171,7 @@ export abstract class Form<F extends Fields> extends Mountable<F> {
 		});
 	}
 
-	extractRawValues(ctx: BaseContext): Record<string, FormDataValue> {
+	extractRawValues(ctx: Context): Record<string, FormDataValue> {
 		return ctx.$body;
 	}
 }

package/src/generate-collections.ts

@@ -1,6 +1,8 @@
 import _locreq from "locreq";
+import * as prettier from "prettier";
 import { promises as fs } from "fs";
 import { assertType, predicates } from "@sealcode/ts-predicates";
+import { getPrettierConfig } from "./utils/prettier";
 
 const target_locreq = _locreq(process.cwd());
 
@@ -63,7 +65,7 @@ ${file_data
 };`;
 	await fs.writeFile(
 		target_locreq.resolve("src/back/collections/collections.ts"),
-		content
+		prettier.format(content, await getPrettierConfig())
 	);
 	// eslint-disable-next-line no-console
 	console.log(

package/src/generate-routes.ts

@@ -1,10 +1,12 @@
 import { promises as fs } from "fs";
+import * as prettier from "prettier";
 import { relative } from "path";
 import _locreq from "locreq";
 import { walkDir } from "./utils/walk";
 import { importPath } from "./utils/import-path";
 import { assertType, predicates } from "@sealcode/ts-predicates";
 import { unescape_url_params } from "./utils/escape-url-params";
+import { getPrettierConfig } from "./utils/prettier";
 
 const target_locreq = _locreq(process.cwd());
 
@@ -46,14 +48,13 @@ export async function generateRoutes(): Promise<void> {
 			}))
 	);
 
-	await fs.writeFile(
-		target_locreq.resolve("src/back/routes/routes.ts"),
-		`// DO NOT EDIT! This file is generated automaticaly with npm run generate-routes
+	const routes_content = `// DO NOT EDIT! This file is generated automaticaly with npm run generate-routes
 
-import Koa, { BaseContext } from "koa";
+import Koa, { Context } from "koa";
 import Router from "@koa/router";
 import { Middlewares } from "sealious";
 import { Mountable } from "@sealcode/sealgen";
+import * as URLs from "./urls"
 
 ${files
 	.map(
@@ -65,11 +66,7 @@ ${files
 	)
 	.join("\n")}
 
-${files
-	.map(({ actionName, url }) => `export const ${actionName}URL = "${url}";`)
-	.join("\n")}
-
-async function handleHtmlPromise(ctx: BaseContext, next: Koa.Next) {
+async function handleHtmlPromise(ctx: Context, next: Koa.Next) {
 	await next();
 	if (ctx.body instanceof Promise) {
 		// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
@@ -94,11 +91,32 @@ function mount(router: Router, URL: string, mountable: Mountable) {
 
 export default function mountAutoRoutes(router: Router) {
 ${files
-	.map(({ actionName }) => `	mount(router, ${actionName}URL, ${actionName});`)
+	.map(
+		({ actionName }) =>
+			`	mount(router, URLs.${actionName}URL, ${actionName});`
+	)
 	.join("\n")}
-}
-`
+}`;
+
+	const urls_content = `${files
+		.map(
+			({ actionName, url }) => `export const ${actionName}URL = "${url}";`
+		)
+		.join("\n")}
+`;
+
+	const prettier_config = await getPrettierConfig();
+	await fs.writeFile(
+		target_locreq.resolve("src/back/routes/routes.ts"),
+		prettier.format(routes_content, prettier_config)
+	);
+
+	await fs.writeFile(
+		target_locreq.resolve("src/back/routes/urls.ts"),
+		prettier.format(urls_content, prettier_config)
 	);
 	// eslint-disable-next-line no-console
-	console.log("Successfuly generated new src/back/routes/routes.ts file");
+	console.log(
+		"Successfuly generated new src/back/routes/routes.ts and src/back/routes/urls.ts"
+	);
 }

package/src/index.ts

@@ -9,8 +9,8 @@ declare module "koa" {
 	}
 }
 
-export * from "./forms/controls/controls";
-export * from "./forms/fields/field";
+export * as Controls from "./forms/controls/controls";
+export * as Fields from "./forms/fields/field";
 export * from "./page/mountable";
 export * from "./page/page";
 export * from "./forms/form";

package/src/make-hidden-inputs.ts

@@ -1,9 +1,10 @@
-import { BaseContext } from "koa";
+import { Context } from "koa";
 import { FlatTemplatable, tempstream } from "tempstream";
-import { FormDataValue, FormField } from ".";
+import { FormDataValue } from ".";
+import { FormField } from "./forms/fields/field";
 
 export function makeHiddenInputs(
-	ctx: BaseContext,
+	ctx: Context,
 	fields: Record<string, FormField>,
 	values: Record<string, FormDataValue>,
 	fields_to_skip: string[]

package/src/page/access-control.ts

@@ -1,8 +1,8 @@
-import { BaseContext } from "koa";
+import { Context } from "koa";
 import { ActionName, Collection } from "sealious";
 
 export function peopleWhoCan(action: ActionName, collection: Collection) {
-	return async function (ctx: BaseContext) {
+	return async function (ctx: Context) {
 		const policy = collection.getPolicy(action);
 		const result = await policy.check(ctx.$context);
 		if (!result) {