Create sign-up example

[dawsontoth]

This starts to get into the territory where a user will want email hooked up to do this well, but one bit at a time.

[BboyAkers]

This can be helpful from my auth application 🙂

Schema:
https://github.com/HarperFast/harper-auth-example/blob/main/schema.graphql

Resource:
https://github.com/HarperFast/harper-auth-example/blob/main/resources.ts#L29-L43

Function to create the account:
https://github.com/HarperFast/harper-auth-example/blob/main/resources.ts#L110-L139

Sidenote: You also want create a role called least_privileged and have the permissions look like this.

{
  "super_user": false,
  "structure_user": false,
  "data": {
    "tables": {
      "User": {
        "read": false,
        "insert": false,
        "update": false,
        "delete": false,
        "attribute_permissions": null
      }
    }
  }
}

Hopefully this is helpful 🙂

[dawsontoth]

@junie-agent Can you open a PR to implement this in the shared skills, please? Here's a complete resource example of a very simple sign-up flow that accepts a username and password, validates them, and creates a user. Document that a role named member needs to be created in the cluster before this will work properly.

import { type Context, type RequestTargetOrId, Resource } from 'harperdb';

export interface SignUpBody {
	username?: string;
	password?: string;
}

export class SignUp extends Resource {
	static loadAsInstance = false;

	allowCreate() {
		return true;
	}

	async post(_target: RequestTargetOrId, data: SignUpBody) {
		const errors: string[] = [];
		if (!data.username) {
			errors.push('username');
		}
		if (!data.password) {
			errors.push('password');
		}
		if (errors.length) {
			return new Response(
				`Please include the ${errors.join(' and ')} in your request.`,
				{ status: 400 },
			);
		}

		const context = this.getContext() as Context;

		try {
			await server.operation({
				operation: 'add_user',
				username: data.username,
				password: data.password,
				role: 'member',
				active: true,
			}, context);
			await context.login(data.username!, data.password!);
		} catch (err) {
			console.error(err);
			return new Response(
				'Please check your credentials and try again.',
				{ status: 403 },
			);
		}
		const user = context.user!;
		return {
			active: user.active,
			role: user.role,
			username: user.username,
			created: user.__createdtime__,
			updated: user.__updatedtime__,
		};
	}
}

[dawsontoth]

@junie-agent Take a look at my comment above, please.

[github-actions]

Junie is failed!

Details: Check job logs for more details

View job run

[dawsontoth]

@junie-agent Can you open a PR to implement this in the shared skills, please? Here's a complete resource example of a very simple sign-up flow that accepts a username and password, validates them, and creates a user. Document that a role named member needs to be created in the cluster before this will work properly.

This can live in the existing templates-shared/all/skills/checking-authentication.md skill.

import { type Context, type RequestTargetOrId, Resource } from 'harperdb';

export interface SignUpBody {
	username?: string;
	password?: string;
}

export class SignUp extends Resource {
	static loadAsInstance = false;

	allowCreate() {
		return true;
	}

	async post(_target: RequestTargetOrId, data: SignUpBody) {
		const errors: string[] = [];
		if (!data.username) {
			errors.push('username');
		}
		if (!data.password) {
			errors.push('password');
		}
		if (errors.length) {
			return new Response(
				`Please include the ${errors.join(' and ')} in your request.`,
				{ status: 400 },
			);
		}

		const context = this.getContext() as Context;

		try {
			await server.operation({
				operation: 'add_user',
				username: data.username,
				password: data.password,
				role: 'member',
				active: true,
			}, context);
			await context.login(data.username!, data.password!);
		} catch (err) {
			console.error(err);
			return new Response(
				'Please check your credentials and try again.',
				{ status: 403 },
			);
		}
		const user = context.user!;
		return {
			active: user.active,
			role: user.role,
			username: user.username,
			created: user.__createdtime__,
			updated: user.__updatedtime__,
		};
	}
}