sealious

v0.19.36

Published

3 months ago

A declarative framework for fast & easy app development.

Downloads

500

0High
0Medium
0Low

Sealious

Sealious is a declarative node.js framework. It creates a full-featured REST-ful API (with user and session management) based on a declarative description of the database schema and policies.

All development is handled on Sealcode's Phabricator. A read-only mirror is stored on Github.

Quick links

Examples

It's best to learn by example. Here are some applications written with the current version of Sealious:

Sealious Playground - simple TODO app written in Sealious and Hotwire. Contains docker setup for mongo, linting, typescript etc. Good starting point for a new app.

References

Example app

Install sealious with npm install --save sealious. Then, in your index.ts:

lang=typescript
import { resolve } from "path";
import Sealious, { App, Collection, FieldTypes, Policies } from "sealious";
const locreq = _locreq(__dirname);

const app = new (class extends App {
    config = {
        datastore_mongo: {
            host: "localhost",
            port: 20723,
            db_name: "sealious-playground",
        },
        upload_path: locreq.resolve("uploaded_files"),
        email: {
            from_address: "[email protected]",
            from_name: "Sealious playground app",
        },
        "www-server": {
            port: 8080, //listen on this port
        },
    };
    manifest = {
        name: "My ToDo list",
        logo: resolve(__dirname, "../assets/logo.png"),
        version: "0.0.1",
        default_language: "en",
        base_url: "localhost:8080",
        admin_email: "[email protected]",
        colors: {
            primary: "#5294a1",
        },
    };
    collections = {
        ...App.BaseCollections,
        tasks: new (class extends Collection {
            fields = {
                title: new FieldTypes.Text(),
                done: new FieldTypes.Boolean(),
            };
            defaultPolicy = new Policies.Public();
        })(),
    };
})();

app.start();

Assuming you have the mongo database running, that's it! The above script creates a fully functional REST API with field validation, error messages, etc. Try sending as POST message to http://localhost:8080/api/v1/collections/tasks to see the API in action. You can learn more about the endpoints created by Sealious for each collection in ./endpoints.remarkup doc file.

The app created by the above code also has some handy ORM-style methods to access and modify items within the collection:

lang=typescript
import {Context} from "sealious";

const tasks = app.collections.tasks.list(new Context(app)).fetch()

To learn more about the ORM methods, see ./orm.remarkup doc file.

Learning Resources

FAQ

How do I add a custom route?

Sealious uses koa and @koa/router to handle HTTP. To add a simple static route:

lang=typescript
app.HTTPServer.router.get("/", async (ctx) => {
    ctx.body = html(/* HTML */ `
        <body>
            <h1>Hello, world!</h1>
        </body>
    `);
});

If you need to perform some user-specific tasks, or need to extract the context in order to call the database, use the extractContext Middleware:

lang=typescript
import {Middlewares} from "sealious";

app.HTTPServer.router.get("/", Middlewares.extractContext(), async (ctx) => {
    const {items: tasks} = await app.collections.tasks.list(ctx.$context).fetch();
    ctx.body = html(/* HTML */ `
        <body>
            <h1>My To do list</h1>
            {tasks.map(task=>task.get("title")).join("")}
        </body>
    `);
});

How do I serve static files?

lang=typescript
app.HTTPServer.addStaticRoute("/", locreq.resolve("public"));

How do I set up SMTP?

When mailer isn't specified, Sealious log messages to stdout instead of sending them via email. To make it use an SMTP connection, add the following to the app definition:

lang=typescript
import { SMTPMailer } from "sealious";

// in app definition:

const app = new (class extends App {
    config = {
        /* ... */
    };
    mailer = new SMTPMailer({
        host: "localhost",
        port: 1025,
        user: "any",
        password: "any",
    });
})();

How do I change a policy for a built-in collection?

lang=typescript
const app = new (class extends App {
    config = {
        /* ... */
    };
    manifest = {
        /* ... */
    };
    collections = {
        ...App.BaseCollections,
        users: App.BaseCollections.users.setPolicy(
            "create",
            new Policies.Public()
        ),
    };
})();

How do I add a field to a built-in collection?

lang=typescript
import {Collections} from "sealious";

const app = new (class extends App {
    config = {
    /* ... */
    };
    manifest = {
    /* ... */
    };
    collections = {
        ...App.BaseCollections,

        users: new (class users extends Collections.users {
            fields = {
                ...App.BaseCollections.users.fields,
                description: new FieldTypes.Text(),
            };
        })(),
    };
})();

How to create a custom login endpoint?

lang=typescript
function LoginForm(username: string = "", error_message?: string) {
    return /* HTML */ `
        <form method="POST" action="/login">
            ${error_message ? `<div>${error_message}</div>` : ""}
            <label for="username">
                Username:
                <input
                    id="username"
                    name="username"
                    type="text"
                    value="${username}"
                    required
                />
            </label>
            <label for="password"
                >Password:
                <input
                    id="password"
                    name="password"
                    type="password"
                    value="${username}"
                    required
            /></label>
            <input type="submit" value="log in" />
        </form>
    `;
}

const router = app.HTTPServer.router;

router.get("/login", async (ctx) => {
    ctx.body = LoginForm();
});

router.post("/login", Middlewares.parseBody(), async (ctx) => {
    try {
        const session_id = await ctx.$app.collections.sessions.login(
            ctx.$body.username as string,
            ctx.$body.password as string
        );
        ctx.cookies.set("sealious-session", session_id, {
            maxAge: 1000 * 60 * 60 * 24 * 7,
            secure: ctx.request.protocol === "https",
            overwrite: true,
        });
        ctx.redirect("/user");
        ctx.status = 303; // more standards- and hotwire-friendly
    } catch (e) {
        ctx.body = LoginForm(ctx.$body.username as string, e.message);
    }
});

How to log out a user?

Create an endpoint where you call the sessions.logout function:

lang=ts
router.get("/logout", async (ctx) => {
	const session_id = ctx.cookies.get("sealious-session");
	ctx.$app.collections.sessions.logout(ctx.$context, session_id);
	ctx.status = 303; // more standards- and hotwire-friendly
});

How to set up a default value to a field?

It's possible, but currently not pretty. This will be fixed in the future.

lang=typescript
const tasks = new (class extends Collection {
	fields = {
		title: new FieldTypes.Text(),
		done: new (class extends FieldTypes.Boolean {
			hasDefaultValue = () => true;
			async getDefaultValue() {
				return false;
			}
		})(),
	};
	defaultPolicy = new Policies.Public();
})();

How to sort by modification/creation time?

lang=typescript
app.collections.entries
	.suList()
	.sort({ "_metadata.modified_at": "desc" }) // or: _metadata.created_at
	.fetch();

How to add custom validation to a collection?

lang=typescript
export class CollectionWithComplexValidation extends Collection {
  fields = {
    color: new FieldTypes.Color(),
  };

  async validate(_: Context, body: CollectionItemBody) {
    if ((body.getInput("color") as string).includes("green")) {
      return [{
          error: "Green is not a creative color",
          fields: ["color"],
       }];
    }
    return [];
  }

  defaultPolicy = new Policies.Public();
}

How to do one-time collection populate?

lang=typescript, name=collection.ts
const my_collection = new (class extends Collection {
  // ...
  async populate(): Promise<void> {
    if (await this.app.Metadata.get("my_collection_populated")) {
      return;
    }
    const app = this.app as TheApp;

	// create the resources here using the regular CRUD functions

    await this.app.Metadata.set("my_collection_populated", "true");
  }
})();

lang=typescript, name=index.ts
void app.start().then(async () => {
	await app.collections.my_collection.populate();
});

How to send an email?

lang=typescript
import { EmailTemplates } from "sealious";

const message = await EmailTemplates.Simple(ctx.$app, {
  text: "Click this link to finish registration:",
  subject: "Rejestracja w zmagazynu.pl",
  to: ctx.$body.email as string,
  buttons: [
    {
      text: "Finish registration",
      href: `${ctx.$app.manifest.base_url}/finish-registration?token=${some_token}`,
    },
  ],
});
message.send(ctx.$app);

How to translate strings returned by the app?

You can add custom translations to the app.strings object.

lang=typescript
const app = new (class extends App {
  // ...
  strings = {
    Welcome: "Witamy",
    you_have_n_points: (n: number) => `Masz ${n} punktów.`,
  };
})();

You can then use the translation anywhere in your app like so:

lang=typescript
app.getString("Welcome", [], "Welcome!");

Note: not all strings generated by Sealious are translatable yet.

How to run custom code when an item is created/edited?

When DerivedValue / CachedValue / ReverseSingleReference aren't enough for the logic of the application, you can use custom logic based on events.

lang=typescript

export default class Patrons extends Collection {
	fields = {
		fullname: new FieldTypes.Text(),
		amount_monthly: new FieldTypes.Float(),
		platform: new FieldTypes.Enum(["patronite", "liberapay", "manual"]),
	};
	defaultPolicy = new Policies.Public();

	async init(app: TheApp, collection_name: string) {
		await super.init(app, collection_name);
		this.on("after:create", async ([context, item, event]) => {
			await app.collections["patron-events"].create(context, {
				message: `Added a new patron from  ${item.get(
					"platform"
				)} for the amount: ${item.get("amount_monthly")}`,
				timestamp: Date.now(),
				patron: item.id,
			});
		});
	}
}

How to detect changes in particular fields?