@fc3/mmcadi 0.1.0

package/src/server.ts

@@ -0,0 +1,140 @@
+import Path from 'path';
+import {mkdir} from 'fs/promises';
+
+import {createServer, HttpServer} from 'lib/server';
+import {NetworkProtocol} from 'lib/network';
+import {IncomingRequest} from 'lib/http';
+import {Session} from 'lib/execution-context';
+import {getFirstValue, getLastValue} from 'lib/array';
+import {NotImplementedError} from 'lib/errors';
+import KeyGenerator from 'lib/key-generator';
+
+import ServerSettings from 'type/server-settings';
+import LoginEndpoint from 'server/endpoint/login';
+import RobotsEndpoint from 'server/endpoint/robots';
+import DefaultRole from 'enum/default-role';
+import GetSettingsEndpoint from 'server/endpoint/settings/get';
+import UpdateSettingsEndpoint from 'server/endpoint/settings/update';
+import LogoutEndpoint from 'server/endpoint/logout';
+import DayEndpoint from 'server/endpoint/day';
+import MonthEndpoint from 'server/endpoint/month';
+import YearEndpoint from 'server/endpoint/year';
+import WeekEndpoint from 'server/endpoint/week';
+import IndexEndpoint from 'server/endpoint/index';
+import CreateActionEndpoint from 'server/endpoint/action/create';
+import CreateSessionEndpoint from 'server/endpoint/session/create';
+import GetActionEndpoint from 'server/endpoint/action/get';
+import GenericPageEndpoint from 'server/endpoint/generic-page';
+import TodayEndpoint from 'server/endpoint/today';
+import StaticFileMiddleware from 'server/middleware/static-file';
+import ErrorHandlerMiddleware from 'server/middleware/error-handler';
+import MemoryRepository from 'server/repository/memory';
+
+const DEFAULT_PORT = 443;
+const DEFAULT_HOSTNAME = 'mmcadi.dev';
+
+class Server extends HttpServer {
+	public constructor(settings: ServerSettings) {
+		const {key, cert} = settings;
+		const protocol = key && cert ? NetworkProtocol.HTTPS : NetworkProtocol.HTTP;
+
+		const server = createServer({
+			key,
+			cert,
+			protocol
+		});
+
+		const port = settings.port || DEFAULT_PORT;
+		const hostname = settings.hostname || DEFAULT_HOSTNAME;
+		const label = 'mmcadi';
+		const current_directory = process.cwd();
+		const default_directory = Path.resolve(current_directory, './public');
+		const public_directory = settings.public_directory || default_directory;
+
+		const repository = settings.repository || new MemoryRepository();
+		const providers = settings.providers || [];
+		const roles = settings.roles || [];
+
+		if (getFirstValue(roles) !== DefaultRole.PUBLIC) {
+			roles.unshift(DefaultRole.PUBLIC);
+		}
+
+		if (getLastValue(roles) !== DefaultRole.CREATOR) {
+			roles.push(DefaultRole.CREATOR);
+		}
+
+		const hydrate = settings.hydrate || function hydrate() {
+			throw new NotImplementedError();
+		};
+
+		const config = {
+			public_directory,
+			repository,
+			providers,
+			roles,
+			hydrate
+		};
+
+		const options = {
+			port,
+			label,
+			hostname,
+			config
+		};
+
+		super(options, server);
+
+		this.addEndpoint(RobotsEndpoint);
+		this.addEndpoint(LoginEndpoint);
+		this.addEndpoint(LogoutEndpoint);
+		this.addEndpoint(GetSettingsEndpoint);
+		this.addEndpoint(UpdateSettingsEndpoint);
+		this.addEndpoint(TodayEndpoint);
+		this.addEndpoint(CreateSessionEndpoint);
+		this.addEndpoint(DayEndpoint);
+		this.addEndpoint(MonthEndpoint);
+		this.addEndpoint(WeekEndpoint);
+		this.addEndpoint(YearEndpoint);
+		this.addEndpoint(IndexEndpoint);
+		this.addEndpoint(GetActionEndpoint);
+		this.addEndpoint(CreateActionEndpoint);
+		this.addEndpoint(GenericPageEndpoint);
+
+		this.prependMiddleware(new StaticFileMiddleware());
+		this.appendMiddleware(new ErrorHandlerMiddleware());
+
+		this.setSessionResolver(this.resolveSession.bind(this));
+	}
+
+	private async resolveSession(request: IncomingRequest): Promise<Session | undefined> {
+		const session_id = request.getSessionIdFromCookie();
+
+		if (session_id === undefined) {
+			return {
+				id: KeyGenerator.generateToken(),
+				account_id: null,
+				username: null
+			};
+		}
+
+		const execution_context = request.getExecutionContext();
+		const {repository} = execution_context.getConfig();
+
+		return repository.findSession(session_id);
+	}
+
+	public async start(): Promise<void> {
+		await this.createPublicDirectory();
+		await super.start();
+	}
+
+	private async createPublicDirectory(): Promise<void> {
+		const {public_directory} = this.getConfig();
+
+		await mkdir(public_directory, {
+			recursive: true
+		});
+	}
+}
+
+export default Server;

package/src/test.ts

@@ -0,0 +1,195 @@
+import Path from 'path';
+import FS from 'fs';
+
+import {isProduction} from 'lib/environment';
+import {InvariantViolation} from 'lib/errors';
+
+import {
+	createServer,
+	header,
+	folder,
+	note,
+	link,
+	multicolumn,
+	background,
+	whitespace
+} from 'index';
+
+import ToolType from 'enum/tool-type';
+import MemoryRepository from 'server/repository/memory';
+import TimePlaceVisibility from 'enum/time-place-visibility';
+
+function getEnvironmentVariable(key: string): string {
+	const value = process.env[key];
+
+	if (value === undefined) {
+		throw new InvariantViolation(`
+			Missing value for required env variable "${key}"
+		`);
+	}
+
+	if (typeof value !== 'string') {
+		throw new InvariantViolation(`
+			Invalid value for env variable "${key}": ${value} (expected string)
+		`);
+	}
+
+	return value;
+}
+
+let key: string | undefined = undefined;
+let cert: string | undefined = undefined;
+let port: number | undefined = undefined;
+
+const public_directory = Path.resolve(process.cwd(), './public');
+
+const repository = new MemoryRepository({
+	accounts: [
+		{
+			id: 'aaa',
+			username: '0x0',
+			password: 'pw',
+			role: 'creator',
+			settings: {
+				default_time_place_visibility: TimePlaceVisibility.NONE,
+				tool_types: [
+					ToolType.LOCK,
+					ToolType.SETTINGS,
+					ToolType.FOLDER,
+					ToolType.TODO,
+					ToolType.NOTE,
+					ToolType.AUDIO,
+					ToolType.IMAGE
+				]
+			}
+		}
+	],
+	sessions: []
+});
+
+if (isProduction()) {
+	const key_filepath = getEnvironmentVariable('KEY_FILEPATH');
+	const cert_filepath = getEnvironmentVariable('CERT_FILEPATH');
+
+	key = FS.readFileSync(key_filepath, 'ascii');
+	cert = FS.readFileSync(cert_filepath, 'ascii');
+} else {
+	port = 4443;
+}
+
+const providers = [
+	{
+		path: '/saffron',
+		handler: async (path: string) => {
+			return [
+				header('saffron'),
+				background('yellow'),
+				note('*an online multiplayer role-playing card game.*'),
+				whitespace(8),
+				multicolumn(3, [
+					whitespace(1),
+					link({
+						label: 'enter world',
+						href: '/saffron',
+						color: 'white'
+					}),
+					whitespace(1)
+				])
+			];
+		}
+	},
+	{
+		path: '/controls',
+		handler: async (path: string) => {
+			return [
+				note('various internal controls for the 0xfc3.net web server.'),
+				folder({
+					emoji: '⚡',
+					title: 'restart server',
+					subtitle: 'restart the server using the latest working code version.',
+					color: 'yellow'
+				}),
+				folder({
+					emoji: '✅',
+					title: 'run tests',
+					subtitle: 'run the automated test suite.',
+					color: 'green'
+				})
+			];
+		}
+	},
+	{
+		path: '/controls/run-tests',
+		handler: async (path: string) => {
+			return [
+				header('✅ run tests'),
+				note('run the automated test suite against the latest version of the code.'),
+				multicolumn(2, [
+					link({
+						label: '⮜ cancel',
+						href: '/controls',
+						color: 'grey'
+					}),
+					link({
+						label: '✅ start tests ⮞',
+						href: '/controls/run-tests/confirm',
+						color: 'green'
+					})
+				])
+			];
+		}
+	},
+	{
+		path: '/controls/restart-server',
+		handler: async (path: string) => {
+			return [
+				header('⚡ restart server'),
+				note('this will trigger a restart of the web server process using the latest version of the code.'),
+				note('are you sure?'),
+				multicolumn(2, [
+					link({
+						label: '⮜ cancel',
+						href: '/controls',
+						color: 'grey'
+					}),
+					link({
+						label: '⚡ restart ⮞',
+						href: '/controls/restart-server/confirm',
+						color: 'red'
+					})
+				])
+			];
+		}
+	},
+	{
+		path: '/controls/restart-server/confirm',
+		handler: async (path: string) => {
+			return [
+				note('restart scheduled.'),
+				link({
+					label: 'go back',
+					href: '/controls',
+					color: 'yellow'
+				})
+			];
+		}
+	}
+];
+
+const roles = [
+	'adventurer',
+	'outrider',
+	'ancient_one'
+];
+
+createServer({
+	key,
+	cert,
+	port,
+	providers,
+	roles,
+	public_directory,
+	repository
+}).catch((error) => {
+	throw error;
+});

package/src/type/account-settings.ts

@@ -0,0 +1,9 @@
+import ToolType from 'enum/tool-type';
+import TimePlaceVisibility from 'enum/time-place-visibility';
+
+type AccountSettings = {
+	readonly tool_types: ToolType[];
+	readonly default_time_place_visibility: TimePlaceVisibility;
+};
+
+export default AccountSettings;

package/src/type/account.ts

@@ -0,0 +1,11 @@
+import AccountSettings from 'type/account-settings';
+
+type Account = {
+	readonly id: string;
+	readonly username: string;
+	readonly password: string;
+	readonly settings: AccountSettings;
+	readonly role: string;
+}
+
+export default Account;

package/src/type/action/add-block.ts

@@ -0,0 +1,74 @@
+import Action from 'type/action';
+import ActionType from 'enum/action-type';
+import BlockType from 'enum/block-type';
+import Color from 'enum/color';
+import Emoji from 'enum/emoji';
+import TimePlaceVisibility from 'enum/time-place-visibility';
+
+interface BaseAddBlockAction extends Action {
+	readonly action_type: ActionType.ADD_BLOCK;
+	readonly block_type: BlockType;
+	readonly index_path: string;
+	readonly create_role: string;
+	readonly read_role: string;
+	readonly update_role: string;
+	readonly delete_role: string;
+	readonly time_place_visibility: TimePlaceVisibility;
+}
+
+export interface AddNoteBlockAction extends BaseAddBlockAction {
+	readonly block_type: BlockType.NOTE;
+	readonly text: string;
+}
+
+export interface AddLinkBlockAction extends BaseAddBlockAction {
+	readonly block_type: BlockType.LINK;
+	readonly href: string;
+	readonly label: string;
+	readonly color: Color;
+}
+
+export interface AddAudioBlockAction extends BaseAddBlockAction {
+	readonly block_type: BlockType.AUDIO;
+}
+
+export interface AddImageBlockAction extends BaseAddBlockAction {
+	readonly block_type: BlockType.IMAGE;
+}
+
+export interface AddHeaderBlockAction extends BaseAddBlockAction {
+	readonly block_type: BlockType.HEADER;
+	readonly title: string;
+}
+
+export interface AddTodoBlockAction extends BaseAddBlockAction {
+	readonly block_type: BlockType.TODO;
+	readonly title: string;
+}
+
+export interface AddBackgroundBlockAction extends BaseAddBlockAction {
+	readonly block_type: BlockType.BACKGROUND;
+	readonly color: Color;
+}
+
+export interface AddWhitespaceBlockAction extends BaseAddBlockAction {
+	readonly block_type: BlockType.WHITESPACE;
+	readonly line_count: number;
+}
+
+export interface AddFolderBlockAction extends BaseAddBlockAction {
+	readonly block_type: BlockType.FOLDER;
+	readonly title: string;
+	readonly subtitle: string;
+	readonly emoji: Emoji;
+	readonly color: Color;
+}
+
+export interface AddMultiColumnBlockAction extends BaseAddBlockAction {
+	readonly block_type: BlockType.MULTI_COLUMN;
+	readonly max_columns: number;
+}
+
+type AddBlockAction = AddNoteBlockAction | AddLinkBlockAction | AddAudioBlockAction | AddImageBlockAction | AddHeaderBlockAction | AddFolderBlockAction | AddMultiColumnBlockAction | AddTodoBlockAction | AddBackgroundBlockAction | AddWhitespaceBlockAction;
+
+export default AddBlockAction;

package/src/type/action/complete-block.ts

@@ -0,0 +1,10 @@
+import Action from 'type/action';
+import ActionType from 'enum/action-type';
+
+interface CompleteBlockAction extends Action {
+	readonly action_type: ActionType.COMPLETE_BLOCK;
+	readonly index_path: string;
+}
+
+export default CompleteBlockAction;
+

package/src/type/action/delete-block.ts

@@ -0,0 +1,11 @@
+import Action from 'type/action';
+import Block from 'type/block';
+import ActionType from 'enum/action-type';
+
+interface DeleteBlockAction extends Action {
+	readonly action_type: ActionType.DELETE_BLOCK;
+	readonly index_path: string;
+	readonly block: Block;
+}
+
+export default DeleteBlockAction;

package/src/type/action/demote-block.ts

@@ -0,0 +1,9 @@
+import Action from 'type/action';
+import ActionType from 'enum/action-type';
+
+interface DemoteBlockAction extends Action {
+	readonly action_type: ActionType.DEMOTE_BLOCK;
+	readonly index_path: string;
+}
+
+export default DemoteBlockAction;

package/src/type/action/edit-block.ts

@@ -0,0 +1,11 @@
+import Action from 'type/action';
+import Block from 'type/block';
+import ActionType from 'enum/action-type';
+
+interface EditBlockAction extends Action {
+	readonly action_type: ActionType.EDIT_BLOCK;
+	readonly index_path: string;
+	readonly block: Block;
+};
+
+export default EditBlockAction;

package/src/type/action/promote-block.ts

@@ -0,0 +1,9 @@
+import Action from 'type/action';
+import ActionType from 'enum/action-type';
+
+interface PromoteBlockAction extends Action {
+	readonly action_type: ActionType.PROMOTE_BLOCK;
+	readonly index_path: string;
+}
+
+export default PromoteBlockAction;

package/src/type/action.ts

@@ -0,0 +1,9 @@
+import ActionType from 'enum/action-type';
+
+interface Action {
+	readonly path: string;
+	readonly action_type: ActionType;
+	readonly editing: boolean;
+}
+
+export default Action;

package/src/type/block/audio.ts

@@ -0,0 +1,8 @@
+import Block from 'type/block';
+import BlockType from 'enum/block-type';
+
+interface AudioBlock extends Block {
+	readonly block_type: BlockType.AUDIO;
+}
+
+export default AudioBlock;

package/src/type/block/background.ts

@@ -0,0 +1,10 @@
+import Block from 'type/block';
+import Color from 'enum/color';
+import BlockType from 'enum/block-type';
+
+interface BackgroundBlock extends Block {
+	readonly block_type: BlockType.BACKGROUND;
+	readonly color: Color;
+}
+
+export default BackgroundBlock;

package/src/type/block/directory.ts

@@ -0,0 +1,18 @@
+import Block from 'type/block';
+import BlockType from 'enum/block-type';
+import DirectoryItemType from 'enum/directory-item-type';
+
+export interface DirectoryItem {
+	readonly filename: string;
+	readonly filesize: number;
+	readonly created_at: number;
+	readonly item_type: DirectoryItemType;
+}
+
+interface DirectoryBlock extends Block {
+	readonly block_type: BlockType.DIRECTORY;
+	readonly path: string;
+	readonly items: DirectoryItem[];
+}
+
+export default DirectoryBlock;

package/src/type/block/ephemeral.ts

@@ -0,0 +1,9 @@
+import Block from 'type/block';
+import BlockType from 'enum/block-type';
+
+interface EphemeralBlock extends Block {
+	readonly block_type: BlockType.EPHEMERAL;
+	readonly label: string;
+}
+
+export default EphemeralBlock;

package/src/type/block/folder.ts

@@ -0,0 +1,14 @@
+import Block from 'type/block';
+import Emoji from 'enum/emoji';
+import Color from 'enum/color';
+import BlockType from 'enum/block-type';
+
+interface FolderBlock extends Block {
+	readonly block_type: BlockType.FOLDER;
+	readonly title: string;
+	readonly subtitle: string;
+	readonly emoji: Emoji;
+	readonly color: Color;
+}
+
+export default FolderBlock;

package/src/type/block/header.ts

@@ -0,0 +1,11 @@
+import Block from 'type/block';
+import HeaderSize from 'enum/header-size';
+import BlockType from 'enum/block-type';
+
+interface HeaderBlock extends Block {
+	readonly block_type: BlockType.HEADER;
+	readonly title: string;
+	readonly size?: HeaderSize;
+}
+
+export default HeaderBlock;

package/src/type/block/image.ts

@@ -0,0 +1,8 @@
+import Block from 'type/block';
+import BlockType from 'enum/block-type';
+
+interface ImageBlock extends Block {
+	readonly block_type: BlockType.IMAGE;
+}
+
+export default ImageBlock;

package/src/type/block/link.ts

@@ -0,0 +1,12 @@
+import Block from 'type/block';
+import Color from 'enum/color';
+import BlockType from 'enum/block-type';
+
+interface LinkBlock extends Block {
+	readonly block_type: BlockType.LINK;
+	readonly label: string;
+	readonly href: string;
+	readonly color: Color;
+}
+
+export default LinkBlock;

package/src/type/block/list.ts

@@ -0,0 +1,24 @@
+import Block from 'type/block';
+import BlockType from 'enum/block-type';
+import FieldDefinition from 'type/field-definition';
+import Resource from 'type/resource';
+
+export type ListDataSource = 'orders';
+
+interface ListBlockWithData extends Block {
+	readonly block_type: BlockType.LIST;
+	readonly items: Resource[];
+	readonly fields: FieldDefinition[];
+	readonly data_source: undefined;
+}
+
+interface ListBlockWithDataSource extends Block {
+	readonly block_type: BlockType.LIST;
+	readonly items: undefined;
+	readonly fields: FieldDefinition[];
+	readonly data_source: ListDataSource;
+}
+
+type ListBlock = ListBlockWithData | ListBlockWithDataSource;
+
+export default ListBlock;

package/src/type/block/multi-column.ts

@@ -0,0 +1,10 @@
+import Block from 'type/block';
+import BlockType from 'enum/block-type';
+
+interface MultiColumnBlock extends Block {
+	readonly block_type: BlockType.MULTI_COLUMN;
+	readonly max_columns: number;
+	readonly children: Block[];
+}
+
+export default MultiColumnBlock;

package/src/type/block/note.ts

@@ -0,0 +1,9 @@
+import Block from 'type/block';
+import BlockType from 'enum/block-type';
+
+interface NoteBlock extends Block {
+	readonly block_type: BlockType.NOTE;
+	readonly text: string;
+}
+
+export default NoteBlock;

package/src/type/block/todo.ts

@@ -0,0 +1,10 @@
+import Block from 'type/block';
+import BlockType from 'enum/block-type';
+
+interface TodoBlock extends Block {
+	readonly block_type: BlockType.TODO;
+	readonly title: string;
+	readonly completed_at: number | null;
+}
+
+export default TodoBlock;

package/src/type/block/whitespace.ts

@@ -0,0 +1,9 @@
+import Block from 'type/block';
+import BlockType from 'enum/block-type';
+
+interface WhitespaceBlock extends Block {
+	readonly block_type: BlockType.WHITESPACE;
+	readonly line_count: number;
+}
+
+export default WhitespaceBlock;

package/src/type/block-metadata.ts

@@ -0,0 +1,14 @@
+import Account from 'type/account';
+
+type BlockMetadata = {
+	readonly page_path: string;
+	readonly editing: boolean;
+	readonly referrer_url: string | null;
+	readonly index_path: string;
+	readonly target_index_path: string | null;
+	readonly roles: string[];
+	readonly account: Account | null;
+	readonly creator_username: string;
+}
+
+export default BlockMetadata;