@sealcode/sealgen 0.4.0 → 0.5.0

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,10 +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>;
@@ -28,14 +29,23 @@ export abstract class FormField<ParsedValue extends unknown = unknown> {
 	}
 
 	public async _validate(
-		ctx: BaseContext,
+		ctx: Context,
 		value: ParsedValue
 	): Promise<FormFieldValidationResponse> {
 		if (
 			this.required &&
 			(value === "" || value === null || value === undefined)
 		) {
-			return { valid: false, message: "This field is required" };
+			return {
+				valid: false,
+
+				message: t(
+					ctx,
+					"field_is_required",
+					[],
+					"This field is required"
+				),
+			};
 		}
 		return this.isValueValid(ctx, value);
 	}
@@ -43,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<Templatable> {
+	): Promise<FlatTemplatable> {
 		return tempstream/* HTML */ `<div>${error.message}</div>`;
 	}
 
-	async render(ctx: BaseContext, data: FormData): Promise<Templatable> {
+	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,13 +96,13 @@ 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): Promise<void> {
+	public async onSuccess(ctx: Context, data: FormData): Promise<void> {
 		ctx.body = await this.render(ctx, {
-			raw_values: ctx.$body,
+			raw_values: data.raw_values,
 			messages: [{ type: "success", text: this.defaultSuccessMessage }],
 		});
 		ctx.status = 422;
@@ -139,7 +139,10 @@ export abstract class Form<F extends Fields> extends Mountable<F> {
 					raw_values: ctx.$body,
 					messages: [],
 				});
-				await this.onSuccess(ctx);
+				await this.onSuccess(ctx, {
+					raw_values: ctx.$body,
+					messages: [],
+				});
 			} catch (e: unknown) {
 				// eslint-disable-next-line no-console
 				console.dir(e, { depth: 5 });
@@ -168,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-routes.ts

@@ -50,6 +50,7 @@ export async function generateRoutes(): Promise<void> {
 		target_locreq.resolve("src/back/routes/routes.ts"),
 		`// DO NOT EDIT! This file is generated automaticaly with npm run generate-routes
 
+import Koa, { Context } from "koa";
 import Router from "@koa/router";
 import { Middlewares } from "sealious";
 import { Mountable } from "@sealcode/sealgen";
@@ -68,12 +69,27 @@ ${files
 	.map(({ actionName, url }) => `export const ${actionName}URL = "${url}";`)
 	.join("\n")}
 
-function mount(router: Router, URL: string, mountable: Mountable){
-	router.use(URL, Middlewares.extractContext(), Middlewares.parseBody());
+async function handleHtmlPromise(ctx: Context, next: Koa.Next) {
+	await next();
+	if (ctx.body instanceof Promise) {
+		// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+		ctx.body = await ctx.body;
+	}
+	ctx.set("content-type", "text/html;charset=utf-8");
+}
+
+function mount(router: Router, URL: string, mountable: Mountable) {
+	router.use(
+		URL,
+		Middlewares.extractContext(),
+		Middlewares.parseBody(),
+		handleHtmlPromise
+	);
 	mountable.init();
 	mountable.mount(router, URL);
 	// to automatically add trailing slashes:
 	router.get(URL.slice(0, -1), (ctx) => ctx.redirect(URL));
+	router.use(URL, (ctx) => ctx.set("content-type", "text/html;charset=utf-8"));
 }
 
 export default function mountAutoRoutes(router: Router) {

package/src/index.ts

@@ -1,18 +1,20 @@
-import Sealious from "sealious";
+import Sealious, { App } from "sealious";
 import { FormDataValue } from "./forms/form";
 
 declare module "koa" {
 	interface BaseContext {
 		$context: Sealious.Context;
+		$app: App;
 		$body: Record<string, FormDataValue>;
 	}
 }
 
-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";
 export * from "./page/props-parser";
 export * from "./utils/utils";
 export * from "./page/list";
+export * from "./utils/translate";

package/src/make-hidden-inputs.ts

@@ -1,13 +1,14 @@
-import { BaseContext } from "koa";
-import { Templatable, tempstream } from "tempstream";
-import { FormDataValue, FormField } from ".";
+import { Context } from "koa";
+import { FlatTemplatable, tempstream } from "tempstream";
+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[]
-): Templatable {
+): FlatTemplatable {
 	return tempstream`${Object.entries(fields)
 		.filter(([key]) => !fields_to_skip.includes(key))
 		.map(

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) {

package/src/page/list.ts

@@ -1,5 +1,6 @@
-import { BaseContext } from "koa";
+import { Context } from "koa";
 import { Collection, CollectionItem, ItemFields, ItemList } from "sealious";
+
 import { Templatable, tempstream, FlatTemplatable } from "tempstream";
 import { peopleWhoCan } from "./access-control";
 import { Page } from "./page";
@@ -23,22 +24,19 @@ export abstract class ListPage<
 	F extends typeof BaseListPageFields
 > extends Page<F> {
 	abstract getItems(
-		ctx: BaseContext,
+		ctx: Context,
 		page: number,
 		itemsPerPage: number,
 		values: Record<string, FormDataValue>
 	): Promise<ItemType[]>;
 
 	abstract getTotalPages(
-		ctx: BaseContext,
+		ctx: Context,
 		itemsPerPage: number,
 		values: Record<string, FormDataValue>
 	): Promise<number>;
 
-	abstract renderItem(
-		ctx: BaseContext,
-		item: ItemType
-	): Promise<FlatTemplatable>;
+	abstract renderItem(ctx: Context, item: ItemType): Promise<FlatTemplatable>;
 
 	filterFields: Record<string, FormField> = {};
 	filterControls: FormFieldControl[] = [];
@@ -50,19 +48,20 @@ export abstract class ListPage<
 		}
 	}
 
-	renderListContainer(_: BaseContext, content: Templatable): FlatTemplatable {
+	renderListContainer(_: Context, content: Templatable): FlatTemplatable {
 		return tempstream`<div>${content}</div>`;
 	}
 
-	async render(ctx: BaseContext): Promise<FlatTemplatable> {
+	async render(ctx: Context): Promise<FlatTemplatable> {
 		const values = this.extractRawValues(ctx);
 		const { parsed: page } = await this.fields.page.getValue(ctx, values);
 		const { parsed: itemsPerPage } =
 			await this.fields.itemsPerPage.getValue(ctx, values);
 
+		const items_promise = this.getItems(ctx, page, itemsPerPage, values);
 		return tempstream`${this.renderPagination(ctx, values)}
 			  ${this.renderFilters(ctx)}
-              ${this.getItems(ctx, page, itemsPerPage, values).then((items) =>
+              ${items_promise.then((items) =>
 					this.renderListContainer(
 						ctx,
 						items.map((item) => this.renderItem(ctx, item))
@@ -71,7 +70,7 @@ export abstract class ListPage<
 	}
 
 	async renderPagination(
-		ctx: BaseContext,
+		ctx: Context,
 		values: Record<string, FormDataValue>
 	): Promise<FlatTemplatable> {
 		const { parsed: page } = await this.fields.page.getValue(ctx, values);
@@ -110,7 +109,7 @@ export abstract class ListPage<
 		</center>`;
 	}
 
-	private renderPageButton(ctx: BaseContext, page: number, text: string) {
+	private renderPageButton(ctx: Context, page: number, text: string) {
 		return /* HTML */ `<a
 			href="${UrlWithNewParams(
 				ctx,
@@ -123,7 +122,7 @@ export abstract class ListPage<
 		>`;
 	}
 
-	async getFilterValues(ctx: BaseContext): Promise<Record<string, unknown>> {
+	async getFilterValues(ctx: Context): Promise<Record<string, unknown>> {
 		const filter = {} as Record<string, unknown>;
 		const raw_values = this.extractRawValues(ctx);
 		for (const [fieldname, field] of Object.entries(this.filterFields)) {
@@ -134,7 +133,7 @@ export abstract class ListPage<
 		return filter;
 	}
 
-	renderFilters(ctx: BaseContext): FlatTemplatable {
+	renderFilters(ctx: Context): FlatTemplatable {
 		const values = this.extractRawValues(ctx);
 		return tempstream/* HTML */ `<form method="GET">
 			${makeHiddenInputs(ctx, this.fields, values, [
@@ -157,20 +156,14 @@ export abstract class SealiousItemListPage<
 		super();
 	}
 
-	async getTotalPages(
-		ctx: BaseContext,
-		itemsPerPage: number
-	): Promise<number> {
+	async getTotalPages(ctx: Context, itemsPerPage: number): Promise<number> {
 		const query = this.collection.list(ctx.$context);
 		await this.addFilter(ctx, query);
 		const { items } = await query.fetch();
 		return Math.ceil(items.length / itemsPerPage);
 	}
 
-	protected async addFilter(
-		ctx: BaseContext,
-		list: ItemList<C>
-	): Promise<void> {
+	protected async addFilter(ctx: Context, list: ItemList<C>): Promise<void> {
 		const filters = await this.getFilterValues(ctx);
 		if (Object.keys(filters).length) {
 			list.filter(filters as Partial<ItemFields<C>>);
@@ -178,7 +171,7 @@ export abstract class SealiousItemListPage<
 	}
 
 	async getItems(
-		ctx: BaseContext,
+		ctx: Context,
 		page: number,
 		itemsPerPage: number
 	): Promise<CollectionItem<C>[]> {
@@ -191,7 +184,7 @@ export abstract class SealiousItemListPage<
 	}
 
 	async renderItem(
-		_: BaseContext,
+		_: Context,
 		item: CollectionItem<C>
 	): Promise<FlatTemplatable> {
 		return `<div>${item.id}</div>`;

package/src/page/mountable.ts

@@ -1,7 +1,7 @@
 import Router from "@koa/router";
 import { FormControl } from "../forms/controls/form-control";
-import { BaseContext } from "koa";
-import { FlatTemplatable, Templatable, tempstream } from "tempstream";
+import { Context } from "koa";
+import { FlatTemplatable, tempstream } from "tempstream";
 import { FormField } from "../forms/fields/field";
 import { FormData, FormDataValue, FormMessage } from "../forms/form";
 
@@ -20,19 +20,19 @@ export abstract class Mountable<F extends Fields = Fields> {
 	abstract mount(router: Router, path: string): void;
 
 	abstract canAccess(
-		ctx: BaseContext
+		ctx: Context
 	): Promise<{ canAccess: boolean; message: string }>;
 
 	abstract renderError(
-		ctx: BaseContext,
+		ctx: Context,
 		error: PageErrorMessage
-	): Promise<Templatable>;
+	): Promise<FlatTemplatable>;
 
-	abstract extractRawValues(ctx: BaseContext): Record<string, FormDataValue>;
+	abstract extractRawValues(ctx: Context): Record<string, FormDataValue>;
 
 	// this one is meant to be overwritten
 	async validateValues(
-		ctx: BaseContext,
+		ctx: Context,
 		data: Record<string, FormDataValue>
 	): Promise<{ valid: boolean; error: string }> {
 		return {
@@ -42,7 +42,7 @@ export abstract class Mountable<F extends Fields = Fields> {
 	}
 
 	protected async validate(
-		ctx: BaseContext,
+		ctx: Context,
 		values: Record<string, FormDataValue>
 	): Promise<{
 		valid: boolean;
@@ -83,7 +83,7 @@ export abstract class Mountable<F extends Fields = Fields> {
 	}
 
 	public renderControls(
-		ctx: BaseContext,
+		ctx: Context,
 		data: FormData<keyof Fields>
 	): FlatTemplatable {
 		return tempstream/* HTML */ `${this.controls.map((control) =>
@@ -92,9 +92,9 @@ export abstract class Mountable<F extends Fields = Fields> {
 	}
 
 	public renderMessages(
-		_: BaseContext,
+		_: Context,
 		data: FormData<keyof Fields>
-	): Templatable {
+	): FlatTemplatable {
 		return tempstream/* HTML */ `<div class="form-messages">
 			${data.messages.map(
 				(message) =>

package/src/page/page.ts

@@ -1,5 +1,5 @@
 import Router from "@koa/router";
-import { BaseContext } from "koa";
+import { Context } from "koa";
 
 import { FlatTemplatable, Templatable, tempstream } from "tempstream";
 import { AllQueryParams } from "..";
@@ -21,20 +21,20 @@ export abstract class Page<
 	}
 
 	// eslint-disable-next-line @typescript-eslint/no-unused-vars
-	async canAccess(_: BaseContext) {
+	async canAccess(_: Context) {
 		return { canAccess: true, message: "" };
 	}
 
 	async renderError(
-		_: BaseContext,
+		_: Context,
 		error: PageErrorMessage
 	): Promise<FlatTemplatable> {
 		return tempstream/* HTML */ `<div>${error.message}</div>`;
 	}
 
-	public abstract render(ctx: BaseContext): Promise<Templatable>;
+	public abstract render(ctx: Context): Promise<FlatTemplatable>;
 
-	extractRawValues(ctx: BaseContext): Record<string, FormDataValue> {
+	extractRawValues(ctx: Context): Record<string, FormDataValue> {
 		return this.propsParser.decode(ctx);
 	}
 }

package/src/page/props-parser.ts

@@ -1,4 +1,4 @@
-import { BaseContext } from "koa";
+import { Context } from "koa";
 import merge from "merge";
 import { FormData, FormDataValue } from "..";
 import { BasePageProps } from "./list";
@@ -10,14 +10,11 @@ export type EncodedProps = Record<string, unknown>;
 // or any other exotic types is done by fields logic.
 
 export abstract class PagePropsParser<PropsType> {
-	abstract decode(ctx: BaseContext): Record<string, FormDataValue>;
+	abstract decode(ctx: Context): Record<string, FormDataValue>;
 	abstract encode(props: Record<string, FormData>): EncodedProps;
 	abstract getHTMLInputName(prop_name: string): string;
 
-	overwriteProp(
-		ctx: BaseContext,
-		new_props: Partial<PropsType>
-	): EncodedProps {
+	overwriteProp(ctx: Context, new_props: Partial<PropsType>): EncodedProps {
 		const result = {};
 		merge.recursive(result, this.decode(ctx), new_props);
 		return result;
@@ -27,7 +24,7 @@ export abstract class PagePropsParser<PropsType> {
 export class AllQueryParams<
 	PropsType extends BasePageProps
 > extends PagePropsParser<PropsType> {
-	decode(ctx: BaseContext): Record<string, FormDataValue> {
+	decode(ctx: Context): Record<string, FormDataValue> {
 		return ctx.query;
 	}