wabe 0.6.9 → 0.6.11

package/src/database/index.ts

@@ -0,0 +1,9 @@
+import type { WabeTypes } from '../server'
+import type { DatabaseAdapter } from './interface'
+
+export interface DatabaseConfig<T extends WabeTypes> {
+	adapter: DatabaseAdapter<T>
+}
+
+export * from './DatabaseController'
+export * from './interface'

package/src/database/interface.ts

@@ -0,0 +1,302 @@
+import type { WabeContext } from '../server/interface'
+import type { WabeTypes } from '../server'
+import type { SchemaInterface } from '../schema'
+
+type IsScalar<T> = T extends string | number | boolean | Date ? true : false
+
+type IsArray<T> = T extends Array<any> ? true : false
+
+type IsObject<T, K extends WabeTypes> = T extends object
+	? T extends K['types'][keyof K['types']]
+		? false
+		: true
+	: false
+
+type ExtractType<
+	T extends WabeTypes,
+	ClassName extends keyof T['types'],
+	FieldName extends keyof T['types'][ClassName],
+> = T['types'][ClassName][FieldName]
+
+type ExtractWhereType<
+	T extends WabeTypes,
+	ClassName extends keyof T['where'],
+	FieldName extends keyof T['where'][ClassName],
+> = T['where'][ClassName][FieldName]
+
+type WhereScalar<T> = {
+	equalTo?: T
+	notEqualTo?: T
+	greaterThan?: T
+	lessThan?: T
+	greaterThanOrEqualTo?: T
+	lessThanOrEqualTo?: T
+	in?: T[]
+	notIn?: T[]
+	contains?: T
+	notContains?: T
+	exists?: boolean
+}
+
+type WhereObject<T> = {
+	[P in keyof T]: IsScalar<T[P]> extends false ? WhereObject<Partial<T[P]>> : WhereScalar<T[P]>
+}
+
+type WhereAggregation<T extends WabeTypes, K = keyof T['where']> = {
+	[P in keyof T['where'][K]]: IsScalar<ExtractWhereType<T, K, P>> extends false
+		? WhereObject<Partial<ExtractWhereType<T, K, P>>>
+		: WhereScalar<ExtractWhereType<T, K, P>>
+}
+
+type WhereConditional<T extends WabeTypes, K = keyof T['where']> = {
+	OR?: Array<WhereType<T, K>>
+	AND?: Array<WhereType<T, K>>
+}
+
+export type WhereType<T extends WabeTypes, K = keyof T['where']> = Partial<WhereAggregation<T, K>> &
+	WhereConditional<T, K>
+
+type SelectObject<T, K extends WabeTypes, Depth extends number = 3> = {
+	[P in keyof T]: IsScalar<T[P]> extends true
+		? boolean
+		: IsArray<T[P]> extends true
+			? T[P] extends Array<infer Item>
+				? (Depth extends 0 ? boolean : SelectObject<Partial<Item>, K, Decrement<Depth>>) | boolean
+				: boolean
+			: IsObject<[P], K> extends true
+				? (Depth extends 0 ? boolean : SelectObject<Partial<T[P]>, K, Decrement<Depth>>) | boolean
+				: boolean
+}
+
+type Decrement<N extends number> = [-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10][N]
+
+export type SelectType<
+	T extends WabeTypes,
+	K extends keyof T['types'],
+	U extends keyof T['types'][K],
+	Depth extends number = 3,
+> = Partial<{
+	[P in U]: IsScalar<ExtractType<T, K, P>> extends true
+		? boolean
+		: IsArray<ExtractType<T, K, P>> extends true
+			? ExtractType<T, K, P> extends Array<infer Item>
+				? (Depth extends 0 ? boolean : SelectObject<Partial<Item>, T, Decrement<Depth>>) | boolean
+				: boolean
+			: ExtractType<T, K, P> extends object
+				?
+						| (Depth extends 0
+								? boolean
+								: SelectObject<Partial<ExtractType<T, K, P>>, T, Decrement<Depth>>)
+						| boolean
+				: boolean
+}>
+
+export type OrderType<
+	T extends WabeTypes,
+	K extends keyof T['types'],
+	U extends keyof T['types'][K],
+> = Record<U, 'ASC' | 'DESC'>
+
+export type OutputType<
+	T extends WabeTypes,
+	K extends keyof T['types'],
+	U extends keyof T['types'][K],
+> = (Pick<T['types'][K], U> & { id: string }) | null
+
+export interface AdapterOptions {
+	databaseUrl: string
+	databaseName: string
+}
+
+export type MutationData<
+	T extends WabeTypes,
+	K extends keyof T['types'],
+	U extends keyof T['types'][K],
+> = Record<U, any>
+
+export interface CountOptions<T extends WabeTypes, K extends keyof T['types']> {
+	className: K
+	where?: WhereType<T, K>
+	context: WabeContext<T>
+}
+
+export interface GetObjectOptions<
+	T extends WabeTypes,
+	K extends keyof T['types'],
+	U extends keyof T['types'][K],
+> {
+	className: K
+	id: string
+	where?: WhereType<T, K>
+	context: WabeContext<T>
+	_skipHooks?: boolean
+	select?: SelectType<T, K, U>
+}
+
+export interface GetObjectsOptions<
+	T extends WabeTypes,
+	K extends keyof T['types'],
+	U extends keyof T['types'][K],
+	W extends keyof T['types'][K],
+> {
+	className: K
+	where?: WhereType<T, K>
+	order?: OrderType<T, K, U>
+	offset?: number
+	first?: number
+	context: WabeContext<T>
+	_skipHooks?: boolean
+	select?: SelectType<T, K, W>
+}
+
+export interface CreateObjectOptions<
+	T extends WabeTypes,
+	K extends keyof T['types'],
+	U extends keyof T['types'][K],
+	W extends keyof T['types'][K],
+> {
+	className: K
+	data: MutationData<T, K, U>
+	context: WabeContext<T>
+	select?: SelectType<T, K, W>
+}
+export interface CreateObjectsOptions<
+	T extends WabeTypes,
+	K extends keyof T['types'],
+	U extends keyof T['types'][K],
+	W extends keyof T['types'][K],
+	X extends keyof T['types'][K],
+> {
+	className: K
+	data: Array<MutationData<T, K, U>>
+	offset?: number
+	first?: number
+	order?: OrderType<T, U, X>
+	context: WabeContext<T>
+	select?: SelectType<T, K, W>
+}
+
+export interface UpdateObjectOptions<
+	T extends WabeTypes,
+	K extends keyof T['types'],
+	U extends keyof T['types'][K],
+	W extends keyof T['types'][K],
+> {
+	className: K
+	id: string
+	where?: WhereType<T, K>
+	data: MutationData<T, K, U>
+	context: WabeContext<T>
+	_skipHooks?: boolean
+	select?: SelectType<T, K, W>
+}
+
+export interface UpdateObjectsOptions<
+	T extends WabeTypes,
+	K extends keyof T['types'],
+	U extends keyof T['types'][K],
+	W extends keyof T['types'][K],
+	X extends keyof T['types'][K],
+> {
+	className: K
+	where: WhereType<T, K>
+	order?: OrderType<T, K, X>
+	data: MutationData<T, K, U>
+	offset?: number
+	first?: number
+	context: WabeContext<T>
+	_skipHooks?: boolean
+	select?: SelectType<T, K, W>
+}
+
+export interface DeleteObjectOptions<
+	T extends WabeTypes,
+	K extends keyof T['types'],
+	U extends keyof T['types'][K],
+> {
+	className: K
+	id: string
+	where?: WhereType<T, K>
+	context: WabeContext<T>
+	select?: SelectType<T, K, U>
+}
+
+export interface DeleteObjectsOptions<
+	T extends WabeTypes,
+	K extends keyof T['types'],
+	U extends keyof T['types'][K],
+	W extends keyof T['types'][K],
+> {
+	className: K
+	where: WhereType<T, K>
+	order?: OrderType<T, K, U>
+	offset?: number
+	first?: number
+	context: WabeContext<T>
+	select?: SelectType<T, K, W>
+}
+
+export interface DatabaseAdapter<T extends WabeTypes> {
+	close(): Promise<void>
+
+	createClassIfNotExist(className: string, schema: SchemaInterface<T>): Promise<any> | any
+
+	initializeDatabase(schema: SchemaInterface<T>): Promise<void>
+	clearDatabase(): Promise<void>
+
+	count<K extends keyof T['types']>(params: CountOptions<T, K>): Promise<number>
+
+	getObject<K extends keyof T['types'], U extends keyof T['types'][K]>(
+		params: GetObjectOptions<T, K, U>,
+	): Promise<OutputType<T, K, U>>
+	getObjects<
+		K extends keyof T['types'],
+		U extends keyof T['types'][K],
+		W extends keyof T['types'][K],
+	>(
+		params: GetObjectsOptions<T, K, U, W>,
+	): Promise<OutputType<T, K, W>[]>
+
+	createObject<
+		K extends keyof T['types'],
+		U extends keyof T['types'][K],
+		W extends keyof T['types'][K],
+	>(
+		params: CreateObjectOptions<T, K, U, W>,
+	): Promise<{ id: string }>
+	createObjects<
+		K extends keyof T['types'],
+		U extends keyof T['types'][K],
+		W extends keyof T['types'][K],
+		X extends keyof T['types'][K],
+	>(
+		params: CreateObjectsOptions<T, K, U, W, X>,
+	): Promise<Array<{ id: string }>>
+
+	updateObject<
+		K extends keyof T['types'],
+		U extends keyof T['types'][K],
+		W extends keyof T['types'][K],
+	>(
+		params: UpdateObjectOptions<T, K, U, W>,
+	): Promise<{ id: string }>
+	updateObjects<
+		K extends keyof T['types'],
+		U extends keyof T['types'][K],
+		W extends keyof T['types'][K],
+		X extends keyof T['types'][K],
+	>(
+		params: UpdateObjectsOptions<T, K, U, W, X>,
+	): Promise<Array<{ id: string }>>
+
+	deleteObject<K extends keyof T['types'], U extends keyof T['types'][K]>(
+		params: DeleteObjectOptions<T, K, U>,
+	): Promise<void>
+	deleteObjects<
+		K extends keyof T['types'],
+		U extends keyof T['types'][K],
+		W extends keyof T['types'][K],
+	>(
+		params: DeleteObjectsOptions<T, K, U, W>,
+	): Promise<void>
+}

package/src/email/DevAdapter.ts

@@ -0,0 +1,7 @@
+import type { EmailAdapter } from './interface'
+
+export class EmailDevAdapter implements EmailAdapter {
+	async send() {
+		return '123456'
+	}
+}

package/src/email/EmailController.test.ts

@@ -0,0 +1,29 @@
+import { describe, expect, it, mock } from 'bun:test'
+import { EmailController } from './EmailController'
+
+describe('EmailController', () => {
+	it('should send email using correct adapter', async () => {
+		const mockSend = mock(() => {})
+		const dummyAdapter = {
+			send: mockSend,
+		}
+
+		// @ts-expect-error
+		const controller = new EmailController(dummyAdapter)
+
+		await controller.send({
+			from: 'from',
+			to: ['to'],
+			subject: 'subject',
+			text: 'text',
+		})
+
+		expect(mockSend).toHaveBeenCalledTimes(1)
+		expect(mockSend).toHaveBeenCalledWith({
+			from: 'from',
+			to: ['to'],
+			subject: 'subject',
+			text: 'text',
+		})
+	})
+})

package/src/email/EmailController.ts

@@ -0,0 +1,13 @@
+import type { EmailAdapter, EmailSendOptions } from './interface'
+
+export class EmailController implements EmailAdapter {
+	public adapter: EmailAdapter
+
+	constructor(adapter: EmailAdapter) {
+		this.adapter = adapter
+	}
+
+	send(options: EmailSendOptions) {
+		return this.adapter.send(options)
+	}
+}

package/src/email/index.ts

@@ -0,0 +1,2 @@
+export * from './interface'
+export * from './DevAdapter'

package/src/email/interface.ts

@@ -0,0 +1,36 @@
+export type HtmlTemplates = {
+	sendOTPCode: {
+		fn: (options: { otp: string }) => string | Promise<string>
+		subject: string
+	}
+}
+
+export interface EmailSendOptions {
+	from: string
+	to: Array<string>
+	subject: string
+	node?: any
+	html?: string
+	text?: string
+}
+
+export interface EmailAdapter {
+	/**
+	 * Send an email using the provided adapter
+	 * @param options Mail options (expeditor, recipient, subject ...)
+	 * @return The id of the email sended, throw an error if something wrong
+	 */
+	send(options: EmailSendOptions): Promise<string>
+}
+
+/**
+ * Configuration for the email in Wabe
+ * @property adapter The adapter to use to send emails
+ * @property mainEmail The email to use as sender for emails sent by Wabe
+ * @property templates The html templates to use for a specific email. If not provided, Wabe will use the default templates
+ */
+export interface EmailConfig {
+	adapter: EmailAdapter
+	mainEmail?: string
+	htmlTemplates?: HtmlTemplates
+}

package/src/email/templates/sendOtpCode.ts

@@ -0,0 +1,120 @@
+export const sendOtpCodeTemplate = (otp: string) => `
+  <!DOCTYPE html>
+  <html lang="en">
+
+  <head>
+      <meta charset="UTF-8">
+      <meta name="viewport" content="width=device-width, initial-scale=1.0">
+      <meta http-equiv="X-UA-Compatible" content="ie=edge">
+      <title>Password Reset</title>
+      <style>
+          body {
+              font-family: 'Arial', sans-serif;
+              margin: 0;
+              padding: 0;
+              background-color: #f4f4f4;
+          }
+
+          .email-container {
+              max-width: 600px;
+              margin: 0 auto;
+              background-color: #ffffff;
+              border-radius: 8px;
+              box-shadow: 0 4px 8px rgba(0, 0, 0, 0.1);
+              overflow: hidden;
+          }
+
+          .header {
+              background-color: #4CAF50;
+              padding: 20px;
+              text-align: center;
+              color: white;
+          }
+
+          .header h1 {
+              margin: 0;
+              font-size: 24px;
+          }
+
+          .content {
+              padding: 20px;
+              font-size: 16px;
+              line-height: 1.6;
+              color: #333333;
+          }
+
+          .content p {
+              margin-bottom: 20px;
+          }
+
+          .otp-code {
+              display: inline-block;
+              padding: 10px 20px;
+              background-color: #4CAF50;
+              color: white;
+              font-size: 18px;
+              font-weight: bold;
+              border-radius: 5px;
+              letter-spacing: 2px;
+              text-align: center;
+          }
+
+          .footer {
+              background-color: #f4f4f4;
+              text-align: center;
+              padding: 10px;
+              font-size: 14px;
+              color: #888888;
+          }
+
+          .footer p {
+              margin: 0;
+          }
+
+          /* Responsive Design */
+          @media screen and (max-width: 600px) {
+              .email-container {
+                  width: 100%;
+              }
+
+              .header h1 {
+                  font-size: 20px;
+              }
+
+              .content {
+                  padding: 15px;
+              }
+
+              .otp-code {
+                  font-size: 16px;
+                  padding: 8px 16px;
+              }
+          }
+      </style>
+  </head>
+
+  <body>
+      <div class="email-container">
+          <!-- Email Header -->
+          <div class="header">
+              <h1>Confirmation code</h1>
+          </div>
+
+          <!-- Email Content -->
+          <div class="content">
+              <p>Hello,</p>
+              <p>Here is your confirmation code. Please use the OTP code (valid for 5 minutes) below to proceed the action:</p>
+              <p class="otp-code">${otp}</p>
+              <p>If you did not request this code, please ignore this email.</p>
+              <p>Thank you</p>
+          </div>
+
+          <!-- Email Footer -->
+          <div class="footer">
+              <p>Powered by Wabe</p>
+          </div>
+      </div>
+  </body>
+
+  </html>
+`

package/src/file/FileController.ts

@@ -0,0 +1,28 @@
+import type { Wabe } from '../server'
+import type { DevWabeTypes } from '../utils/helper'
+import type { FileAdapter, ReadFileOptions } from './interface'
+
+export class FileController implements FileAdapter {
+	public adapter: FileAdapter
+	private wabe: Wabe<DevWabeTypes>
+
+	constructor(adapter: FileAdapter, wabe: Wabe<any>) {
+		this.adapter = adapter
+		this.wabe = wabe
+	}
+
+	uploadFile(file: File) {
+		return this.adapter.uploadFile(file)
+	}
+
+	readFile(fileName: string, options?: ReadFileOptions) {
+		return this.adapter.readFile(fileName, {
+			...options,
+			port: this.wabe.config.port,
+		})
+	}
+
+	deleteFile(fileName: string) {
+		return this.adapter.deleteFile(fileName)
+	}
+}

package/src/file/FileDevAdapter.ts

@@ -0,0 +1,51 @@
+import { writeFile, mkdir, rm, access, constants } from 'node:fs/promises'
+import path from 'node:path'
+import type { FileAdapter, ReadFileOptions } from '.'
+
+export class FileDevAdapter implements FileAdapter {
+	private basePath = 'bucket'
+	private rootPath = process.cwd()
+
+	async uploadFile(file: File): Promise<void> {
+		const fullPath = path.join(this.rootPath, this.basePath)
+
+		await mkdir(fullPath, { recursive: true })
+
+		const fileType = file.type
+
+		let fileContent: Buffer
+
+		if (fileType.startsWith('text') || fileType.includes('json')) {
+			const textContent = await file.text()
+			fileContent = Buffer.from(textContent, 'utf-8')
+		} else {
+			const arrayBuffer = await file.arrayBuffer()
+			fileContent = Buffer.from(arrayBuffer)
+		}
+
+		await writeFile(path.join(fullPath, file.name), fileContent)
+	}
+
+	async readFile(fileName: string, options?: ReadFileOptions): Promise<string | null> {
+		const filePath = path.join(this.rootPath, this.basePath, fileName)
+
+		try {
+			await access(filePath, constants.F_OK)
+			return `http://127.0.0.1:${options?.port || 3001}/${this.basePath}/${fileName}`
+		} catch {
+			return null
+		}
+	}
+
+	async deleteFile(fileName: string): Promise<void> {
+		const filePath = path.join(this.rootPath, this.basePath, fileName)
+
+		try {
+			await access(filePath, constants.F_OK)
+
+			await rm(filePath)
+		} catch {
+			// Do nothing
+		}
+	}
+}

package/src/file/hookDeleteFile.ts

@@ -0,0 +1,25 @@
+import type { HookObject } from '../hooks/HookObject'
+
+const deleteFile = async (hookObject: HookObject<any, any>) => {
+	const schema = hookObject.context.wabe.config.schema?.classes?.find(
+		(currentClass) => currentClass.name === hookObject.className,
+	)
+
+	if (!schema) return
+
+	await Promise.all(
+		Object.entries(schema.fields)
+			.filter(([_, value]) => value.type === 'File')
+			.map(([fieldName]) => {
+				const fileName = hookObject.originalObject?.[fieldName]?.name as string
+
+				if (!fileName) return Promise.resolve()
+
+				if (!hookObject.context.wabe.controllers.file) throw new Error('No file adapter found')
+
+				return hookObject.context.wabe.controllers.file?.deleteFile(fileName)
+			}),
+	)
+}
+
+export const defaultAfterDeleteFile = (hookObject: HookObject<any, any>) => deleteFile(hookObject)

package/src/file/hookReadFile.ts

@@ -0,0 +1,66 @@
+import type { HookObject } from '../hooks/HookObject'
+
+const getFile = async (hookObject: HookObject<any, any>) => {
+	const schema = hookObject.context.wabe.config.schema?.classes?.find(
+		(currentClass) => currentClass.name === hookObject.className,
+	)
+
+	if (!schema) return
+
+	const urlCacheInSeconds = hookObject.context.wabe.config.file?.urlCacheInSeconds || 3600 * 24
+
+	// After read we get the file URL and we update the field url with an URL.
+	// For security purpose we recommend to use a presigned URL
+	await Promise.all(
+		Object.entries(schema.fields)
+			.filter(([_, value]) => value.type === 'File')
+			.map(async ([fieldName]) => {
+				const fileInfo = hookObject.object?.[fieldName]
+
+				if (!fileInfo) return
+
+				const fileName = fileInfo.name as string
+
+				if (!fileName && fileInfo.url) return fileInfo.url
+
+				const fileUrlGeneratedAt = new Date(fileInfo.urlGeneratedAt)
+
+				if (
+					fileUrlGeneratedAt &&
+					fileUrlGeneratedAt.getTime() + urlCacheInSeconds * 1000 > Date.now()
+				)
+					return
+
+				if (!hookObject.context.wabe.controllers.file) throw new Error('No file adapter found')
+
+				const fileUrlFromBucket = await hookObject.context.wabe.controllers.file?.readFile(fileName)
+
+				const newUrl = fileUrlFromBucket || fileInfo.url
+				const newUrlGeneratedAt = new Date()
+
+				// Mutate the object returned to the caller so AfterRead effects are visible immediately
+				// @ts-expect-error
+				hookObject.object[fieldName] = {
+					...fileInfo,
+					urlGeneratedAt: newUrlGeneratedAt,
+					url: newUrl,
+				}
+
+				return hookObject.context.wabe.controllers.database.updateObject({
+					className: hookObject.className,
+					context: hookObject.context,
+					id: hookObject.object?.id || '',
+					data: {
+						[fieldName]: {
+							...fileInfo,
+							urlGeneratedAt: newUrlGeneratedAt,
+							url: newUrl,
+						},
+					},
+					_skipHooks: true,
+				})
+			}),
+	)
+}
+
+export const defaultAfterReadFile = (hookObject: HookObject<any, any>) => getFile(hookObject)