wabe 0.6.9 → 0.6.11

package/src/hooks/index.ts

@@ -0,0 +1,414 @@
+import type { MutationData, OutputType, Select, WhereType } from '../database'
+import { contextWithoutGraphQLCall } from '../utils'
+import { defaultAfterDeleteFile } from '../file/hookDeleteFile'
+import { defaultAfterReadFile } from '../file/hookReadFile'
+import { defaultBeforeCreateUpload, defaultBeforeUpdateUpload } from '../file/hookUploadFile'
+import type { WabeConfig, WabeTypes } from '../server'
+import type { WabeContext } from '../server/interface'
+
+import type { DevWabeTypes } from '../utils/helper'
+import { HookObject } from './HookObject'
+import {
+	defaultBeforeCreateForCreatedAt,
+	defaultBeforeCreateForDefaultValue,
+	defaultBeforeUpdateForUpdatedAt,
+} from './defaultFields'
+import { defaultDeleteSessionOnDeleteUser } from './deleteSession'
+import {
+	defaultCheckPermissionOnCreate,
+	defaultCheckPermissionOnDelete,
+	defaultCheckPermissionOnRead,
+	defaultCheckPermissionOnUpdate,
+} from './permissions'
+import {
+	defaultCheckProtectedOnBeforeCreate,
+	defaultCheckProtectedOnBeforeRead,
+	defaultCheckProtectedOnBeforeUpdate,
+} from './protected'
+import {
+	defaultSearchableFieldsBeforeCreate,
+	defaultSearchableFieldsBeforeUpdate,
+} from './searchableFields'
+import {
+	defaultAfterCreateSession,
+	defaultAfterDeleteSession,
+	defaultBeforeUpdateSessionOnUser,
+} from './session'
+import { defaultSetEmail, defaultSetEmailOnUpdate } from './setEmail'
+import { defaultSetupAclBeforeCreate, defaultSetupAclOnUserAfterCreate } from './setupAcl'
+import { hashFieldHook } from './hashFieldHook'
+import { defaultBeforeCreateUser } from './createUser'
+import {
+	defaultCallAuthenticationProviderOnBeforeCreateUser,
+	defaultCallAuthenticationProviderOnBeforeUpdateUser,
+} from './authentication'
+
+export enum OperationType {
+	AfterCreate = 'afterCreate',
+	AfterUpdate = 'afterUpdate',
+	AfterDelete = 'afterDelete',
+	AfterRead = 'afterRead',
+	BeforeCreate = 'beforeCreate',
+	BeforeUpdate = 'beforeUpdate',
+	BeforeDelete = 'beforeDelete',
+	BeforeRead = 'beforeRead',
+}
+
+export type Hook<T extends WabeTypes, K extends keyof WabeTypes['types']> = {
+	operationType: OperationType
+	// If the className is undefined the hook is called on each class
+	className?: K
+	// The priority of the hook. The lower the number the earlier the hook is called
+	// The priority 0 is for the security hooks
+	// The default priority is 1
+	priority: number
+	callback: (hookObject: HookObject<T, K>) => Promise<void> | void
+}
+
+export const _findHooksByPriority = async <T extends keyof WabeTypes['types']>({
+	className,
+	operationType,
+	priority,
+	config,
+}: {
+	operationType: OperationType
+	className: T
+	priority: number
+	config: WabeConfig<any>
+}) =>
+	config.hooks?.filter(
+		(hook) =>
+			hook.operationType === operationType &&
+			hook.priority === priority &&
+			(className === hook.className || !hook.className),
+	) || []
+
+const _getHooksOrderByPriorities = (config: WabeConfig<any>) =>
+	config.hooks
+		?.reduce((acc, hook) => {
+			if (!acc.includes(hook.priority)) acc.push(hook.priority)
+
+			return acc
+		}, [] as number[])
+		.sort((a, b) => a - b) || []
+
+export const initializeHook = <T extends WabeTypes, K extends keyof T['types']>({
+	className,
+	newData,
+	context,
+	select,
+	objectLoader,
+	objectsLoader,
+}: {
+	className: K
+	newData?: MutationData<DevWabeTypes, any, any>
+	select: Select
+	context: WabeContext<any>
+	objectLoader?: (id: string) => Promise<OutputType<DevWabeTypes, any, any> | null>
+	objectsLoader?: (opts: {
+		where?: WhereType<DevWabeTypes, any>
+		ids: string[]
+	}) => Promise<OutputType<DevWabeTypes, any, any>[]>
+}) => {
+	const computeObject = ({ id }: { id?: string }): Promise<OutputType<DevWabeTypes, any, any>> => {
+		// If we don't have an id, like for example after delete, we return an empty object
+		// Hook after delete will be called but we should not have any object
+		// Same of before create
+		// @ts-expect-error
+		if (!id) return {}
+
+		// @ts-expect-error
+		if (!objectLoader) return {}
+
+		return objectLoader(id)
+	}
+
+	const computeObjects = async ({
+		where,
+		ids,
+	}: {
+		where?: WhereType<DevWabeTypes, any>
+		ids: string[]
+	}): Promise<OutputType<DevWabeTypes, any, any>[]> => {
+		// @ts-expect-error
+		if (!where && ids.length === 0) return [{}] // Because we have a map below, so we need to have at least one turn
+
+		if (!objectsLoader) return [{}] as any
+
+		const res = await objectsLoader({ where, ids })
+
+		// @ts-expect-error
+		if (res.length === 0) return [{}] // Because we have a map below, so we need to have at least one turn
+
+		return res
+	}
+
+	const hooksOrderByPriorities = _getHooksOrderByPriorities(context.wabe.config)
+
+	return {
+		runOnSingleObject: async (options: {
+			operationType: OperationType
+			id?: string
+			originalObject?: OutputType<DevWabeTypes, any, any>
+			object?: OutputType<DevWabeTypes, any, any>
+		}): Promise<MutationData<T, K, any>> => {
+			if (hooksOrderByPriorities.length === 0) return { object: undefined, newData: undefined }
+
+			const object =
+				options.object ??
+				(options.operationType === OperationType.AfterDelete
+					? ({} as any)
+					: await computeObject({
+							id: options.id,
+						}))
+
+			const hookObject = new HookObject<DevWabeTypes, K>({
+				className,
+				newData,
+				operationType: options.operationType,
+				context: contextWithoutGraphQLCall(context),
+				object,
+				originalObject: options.originalObject,
+				select,
+			})
+
+			// We need to keep the order of the data but we need to execute the hooks in parallel
+			await hooksOrderByPriorities.reduce(async (acc, priority) => {
+				await acc
+
+				const hooksToCompute = await _findHooksByPriority({
+					className,
+					operationType: options.operationType,
+					priority,
+					config: context.wabe.config,
+				})
+
+				await Promise.all(hooksToCompute.map((hook) => hook.callback(hookObject)))
+			}, Promise.resolve())
+
+			return { object, newData: hookObject.getNewData() }
+		},
+
+		runOnMultipleObjects: async (options: {
+			operationType: OperationType
+			where?: WhereType<any, any>
+			ids?: string[]
+			originalObjects?: OutputType<DevWabeTypes, any, any>[]
+			objects?: OutputType<DevWabeTypes, any, any>[]
+		}) => {
+			if (hooksOrderByPriorities.length === 0) return { objects: [], newData: [newData || {}] }
+
+			const objects =
+				options.objects ||
+				(await computeObjects({
+					where: options.where,
+					ids: options.ids || [],
+				}))
+
+			const objectsToUseInMap =
+				(options.operationType === OperationType.AfterDelete ? options.originalObjects : objects) ||
+				[]
+
+			const newDataAfterHooks = await Promise.all(
+				objectsToUseInMap.map(async (object) => {
+					const originalObjectToUse = (options.originalObjects || []).find(
+						(originalObject) => originalObject?.id === object?.id,
+					)
+
+					const hookObject = new HookObject<DevWabeTypes, K>({
+						className,
+						newData,
+						operationType: options.operationType,
+						context: contextWithoutGraphQLCall(context),
+						object,
+						originalObject: originalObjectToUse,
+						select,
+					})
+
+					// We need to keep the order of the data but we need to execute the hooks in parallel
+					await hooksOrderByPriorities.reduce(async (acc, priority) => {
+						await acc
+
+						const hooksToCompute = await _findHooksByPriority({
+							className,
+							operationType: options.operationType,
+							priority,
+							config: context.wabe.config,
+						})
+
+						await Promise.all(hooksToCompute.map((hook) => hook.callback(hookObject)))
+					}, Promise.resolve())
+
+					return hookObject.getNewData()
+				}),
+			)
+
+			return { objects, newData: newDataAfterHooks }
+		},
+	}
+}
+
+export const getDefaultHooks = (): Hook<any, any>[] => [
+	{
+		operationType: OperationType.BeforeRead,
+		priority: 0,
+		callback: defaultCheckPermissionOnRead,
+	},
+	{
+		operationType: OperationType.BeforeUpdate,
+		priority: 0,
+		callback: defaultCheckPermissionOnUpdate,
+	},
+	{
+		operationType: OperationType.BeforeCreate,
+		priority: 0,
+		callback: defaultCheckPermissionOnCreate,
+	},
+	{
+		operationType: OperationType.BeforeDelete,
+		priority: 0,
+		callback: defaultCheckPermissionOnDelete,
+	},
+	{
+		operationType: OperationType.BeforeRead,
+		priority: 0,
+		callback: defaultCheckProtectedOnBeforeRead,
+	},
+	{
+		operationType: OperationType.BeforeUpdate,
+		priority: 0,
+		callback: defaultCheckProtectedOnBeforeUpdate,
+	},
+	{
+		operationType: OperationType.BeforeCreate,
+		priority: 0,
+		callback: defaultCheckProtectedOnBeforeCreate,
+	},
+	{
+		operationType: OperationType.BeforeCreate,
+		priority: 1,
+		callback: defaultBeforeCreateForCreatedAt,
+	},
+	{
+		operationType: OperationType.BeforeCreate,
+		priority: 1,
+		callback: defaultBeforeCreateForDefaultValue,
+	},
+	{
+		operationType: OperationType.BeforeUpdate,
+		priority: 1,
+		callback: defaultBeforeUpdateForUpdatedAt,
+	},
+	{
+		operationType: OperationType.BeforeCreate,
+		priority: 1,
+		callback: defaultBeforeCreateUpload,
+	},
+	{
+		operationType: OperationType.BeforeUpdate,
+		priority: 1,
+		callback: defaultBeforeUpdateUpload,
+	},
+	{
+		operationType: OperationType.AfterRead,
+		priority: 1,
+		callback: defaultAfterReadFile,
+	},
+	{
+		operationType: OperationType.AfterDelete,
+		priority: 1,
+		callback: defaultAfterDeleteFile,
+	},
+
+	{
+		operationType: OperationType.BeforeCreate,
+		// Need to be after email setup
+		priority: 3,
+		callback: defaultSearchableFieldsBeforeCreate,
+	},
+	{
+		operationType: OperationType.BeforeUpdate,
+		// Need to be after email setup
+		priority: 3,
+		callback: defaultSearchableFieldsBeforeUpdate,
+	},
+	{
+		operationType: OperationType.BeforeCreate,
+		priority: 0,
+		callback: defaultSetupAclBeforeCreate,
+	},
+	{
+		className: 'User',
+		operationType: OperationType.AfterCreate,
+		priority: 0,
+		callback: defaultSetupAclOnUserAfterCreate,
+	},
+	{
+		className: 'User',
+		operationType: OperationType.BeforeCreate,
+		// Need to be after authentication for update and create user hook
+		priority: 2,
+		callback: defaultSetEmail,
+	},
+	{
+		className: 'User',
+		operationType: OperationType.BeforeUpdate,
+		// Need to be after authentication for update and create user hook
+		priority: 2,
+		callback: defaultSetEmailOnUpdate,
+	},
+	{
+		className: 'User',
+		// TODO: It should better to do this in after delete to avoid case when deleteUser failed
+		// For the moment KISS
+		operationType: OperationType.BeforeDelete,
+		priority: 1,
+		callback: defaultDeleteSessionOnDeleteUser,
+	},
+	{
+		className: '_Session',
+		operationType: OperationType.AfterCreate,
+		priority: 1,
+		callback: defaultAfterCreateSession,
+	},
+	{
+		className: '_Session',
+		operationType: OperationType.AfterDelete,
+		priority: 1,
+		callback: defaultAfterDeleteSession,
+	},
+	{
+		className: 'User',
+		operationType: OperationType.BeforeUpdate,
+		priority: 1,
+		callback: defaultBeforeUpdateSessionOnUser,
+	},
+	{
+		operationType: OperationType.BeforeCreate,
+		priority: 1,
+		callback: hashFieldHook,
+	},
+	{
+		operationType: OperationType.BeforeUpdate,
+		priority: 1,
+		callback: hashFieldHook,
+	},
+	{
+		className: 'User',
+		operationType: OperationType.BeforeCreate,
+		priority: 1,
+		callback: defaultBeforeCreateUser,
+	},
+	{
+		className: 'User',
+		operationType: OperationType.BeforeCreate,
+		priority: 1,
+		callback: defaultCallAuthenticationProviderOnBeforeCreateUser,
+	},
+	{
+		className: 'User',
+		operationType: OperationType.BeforeUpdate,
+		priority: 1,
+		callback: defaultCallAuthenticationProviderOnBeforeUpdateUser,
+	},
+]